目录中的产品列表

Deprecated

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

我应该使用哪种方法而不是过时的方法?

对于您放置在市场上的每个产品,将返回有关此产品链接到的市场卡的信息:

  • 当前卡(marketSku)的ID,正在进行审核的卡以及最后被拒绝的卡。
  • 市场卡上显示的产品说明。 例如,包装的尺寸和产品的重量。

结果逐页返回。 输出数据包含下一页的ID。

商店目录中的产品数量是如何计算的?

根据最近七天(不包括今天)的数据。

⚙️ 限制: 每分钟10,000件物品

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offer-mapping-entries

Path parameters

Name

Description

campaignId

Type: integer

广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

  • 商店的标识符,显示在商家的个人帐户中。
  • 广告活动。

Min value: 1

Query parameters

Name

Description

availability

Type: string[]

按产品交付计划过滤:

  • ACTIVE — 会有送货的。
  • INACTIVE — 不会有交付:产品有库存,但您不再计划交付。
  • DELISTED — 存档:该产品已缺货,将不再有交付。

您可以在一个参数中指定多个值,用逗号分隔,也可以在几个相同的参数中指定多个值。 例如:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

在请求中,您可以指定参数 shopSku,或用于过滤产品的任何参数。 共享参数 shopSku 和过滤选项将导致错误。

Unique items: true

Example: ``

category_id

Type: integer[]

通过市场上的类别ID进行过滤。

要找出产品所属类别的ID,请使用请求 POST v2/categories/tree.

您可以在一个参数中指定多个标识符(用逗号分隔),也可以在几个相同的参数中指定多个标识符。 例如:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

在请求中,您可以指定参数 shopSku,或用于过滤产品的任何参数。 共享参数 shopSku 和过滤选项将导致错误。

Unique items: true

Example: ``

limit

Type: integer

每页的值数。

Min value: 1

mapping_kind

Type: string

映射的类型。 映射类型:

  • ALL — 所有产品。
  • ACTIVE — 即卖产品。

Enum: ACTIVE, ALL

offer_id

Type: string[]

目录中的产品Id。

Unique items: true

Example: ``

page_token

Type: string

结果页面的ID。

如果省略该参数,则返回第一页。

我们建议传输输出参数的值 nextPageToken,在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

shop_sku

Type: string[]

目录中的产品Id。

使用参数 offer_id 而不是这个参数。

Unique items: true

Example: ``

status

Type: string[]

按产品发布状态过滤:

  • READY — 该产品已通过审核。
  • IN_WORK — 该产品正在进行适度。
  • NEED_CONTENT — 对于没有的产品 SKU 在市场上 marketSku 您需要自己找到一张卡或创建一张卡。
  • NEED_INFO — 由于产品描述中的错误或信息缺失,产品审核失败。
  • REJECTED — 该产品没有通过审核,因为市场不打算发布此类产品。
  • SUSPENDED — 该产品尚未通过审核,因为市场尚未放置此类产品。
  • OTHER — 由于另一个原因,该产品未能审核。

您可以在一个参数中指定多个状态(以逗号分隔),也可以在多个相同的参数中指定多个状态。 例如:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

请求可以指定shopSku参数或用于筛选产品的任何参数。 同时使用shopSku参数和过滤参数将导致错误。

Unique items: true

Example: ``

vendor

Type: string[]

按产品品牌过滤。

您可以在一个参数中指定多个品牌,用逗号分隔,也可以在几个相同的参数中指定多个品牌。 例如:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

为了将产品包含在过滤结果中,其品牌必须与请求中指定的品牌之一完全匹配。 例如,如果指定了品牌 Schwarzkopf,那么结果中就没有产品了 Schwarzkopf Professional.

如果品牌名称包含表中未包含的字符 ASCII (包括西里尔字符),用于它们 URL-编码。 例如,一个空间 — %20,撇号"'" — %27等。 有关详细信息,请参阅 编码 URL 俄语维基百科.

请求可以指定shopSku参数或用于筛选产品的任何参数。 共享参数 shopSku 和过滤选项将导致错误。

Unique items: true

Example: ``

Responses

200 OK

目录中有关产品的信息。

Body

application/json
{
  "status": "OK",
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offerMappingEntries": [
      {}
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

    • OK — 没有错误。
    • ERROR — 处理请求时出错。

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    offerMappingEntries

    Type: object[]

    目录中有关产品的信息。

    Example
    [
      {
        "offer": {
          "name": "Ударная дрель Makita HP1630, 710 Вт",
          "shopSku": "example",
          "category": "example",
          "vendor": "LEVENHUK",
          "vendorCode": "VNDR-0005A",
          "description": "example",
          "id": "example",
          "feedId": 0,
          "barcodes": [
            null
          ],
          "urls": [
            null
          ],
          "pictures": [
            null
          ],
          "manufacturer": "example",
          "manufacturerCountries": [
            null
          ],
          "minShipment": 0,
          "transportUnitSize": 0,
          "quantumOfSupply": 0,
          "deliveryDurationDays": 0,
          "boxCount": 0,
          "customsCommodityCodes": [
            null
          ],
          "weightDimensions": {},
          "supplyScheduleDays": [
            null
          ],
          "shelfLifeDays": 0,
          "lifeTimeDays": 0,
          "guaranteePeriodDays": 0,
          "processingState": {},
          "availability": "ACTIVE",
          "shelfLife": {},
          "lifeTime": {},
          "guaranteePeriod": {},
          "certificate": "example",
          "price": 0.5
        },
        "mapping": {
          "marketSku": 1,
          "categoryId": 0
        },
        "awaitingModerationMapping": {
          "marketSku": 1,
          "categoryId": 0
        },
        "rejectedMapping": {
          "marketSku": 1,
          "categoryId": 0
        }
      }
    ]
    

    paging

    Type: object

    All of 2 types
    • Type: object

      nextPageToken

      Type: string

      下一个结果页面的ID。

      Example: example

      下一页的ID。

      Example
      {
        "nextPageToken": "example"
      }
      
    • Type: object

      prevPageToken

      Type: string

      上一个结果页面的ID。

      Example: example

      Example
      {
        "prevPageToken": "example"
      }
      

    有关结果页的信息。

    Example
    {
      "nextPageToken": "example",
      "prevPageToken": "example"
    }
    

    目录中有关产品的信息。

    Example
    {
      "paging": {
        "nextPageToken": "example",
        "prevPageToken": "example"
      },
      "offerMappingEntries": [
        {
          "offer": {},
          "mapping": {
            "marketSku": 1,
            "categoryId": 0
          },
          "awaitingModerationMapping": {
            "marketSku": 1,
            "categoryId": 0
          },
          "rejectedMapping": {
            "marketSku": 1,
            "categoryId": 0
          }
        }
      ]
    }
    
    Example
    {
      "result": {
        "paging": {
          "nextPageToken": "example",
          "prevPageToken": "example"
        },
        "offerMappingEntries": [
          {
            "offer": {},
            "mapping": {},
            "awaitingModerationMapping": {},
            "rejectedMapping": {}
          }
        ]
      }
    }
    

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

No longer supported, please use an alternative and newer version.

什么是GTIN?
[医]GTIN — 这是在单个国际数据库中分配给产品的唯一编号。 GS1. 此编号生成EAN、UPC或ISBN条形码。

如何确保产品在数据库中
你可以在 验证页面 在GS1协会的网站上。 如果未找到产品,请向供应商索取GTIN代码。

如何为您的产品获取GTIN
要接收GTIN代码,制造商需要加入GS1协会并注册产品。