目录中有关产品的信息

方法适用于模式:FBY, FBS, Express 和 DBS.

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

返回目录中的产品列表,它们在市场上的类别以及每个产品的特性。

它可以用在三种方式:

  • 设置感兴趣的人的名单 SKU;
  • 设置过滤器 — 在这种情况下,结果将逐页返回;
  • 不要发送请求正文以获取目录中所有产品的列表。
⚙️ 限制: 每分钟600个请求,每个请求不超过200个产品

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-mappings

Path parameters

Name

Description

businessId*

Type: integer<int64>

内阁ID。 要找到答案,请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店?

Min value: 1

Query parameters

Name

Description

language

Type: string

接受和返回参数中的值的语言 namedescription.

默认值: RU.
语言:

  • RU — 俄语。
  • UZ — 乌兹别克。

Enum: RU, UZ

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

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

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

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

Body

application/json
{
    "offerIds": [
        "string"
    ],
    "cardStatuses": [
        "HAS_CARD_CAN_NOT_UPDATE"
    ],
    "categoryIds": [
        0
    ],
    "vendorNames": [
        "string"
    ],
    "tags": [
        "string"
    ],
    "archived": false
}

Name

Description

archived

Type: boolean

按存档中的位置过滤。

传下去 true 以接收存档中的项目。 如果过滤器未填充或通过 false,响应返回不在存档中的项。

cardStatuses

Type: string[]

按卡状态过滤。

什么是产品卡?
产品卡状态:

  • HAS_CARD_CAN_NOT_UPDATE — 的市场卡。
  • HAS_CARD_CAN_UPDATE — 你可以添加它。
  • HAS_CARD_CAN_UPDATE_ERRORS — 更改尚未被接受。
  • HAS_CARD_CAN_UPDATE_PROCESSING — 变化正在审查中。
  • NO_CARD_NEED_CONTENT — 创建一张卡片。
  • NO_CARD_MARKET_WILL_CREATE — 创建一个市场。
  • NO_CARD_ERRORS — 它不是由于错误而创建的。
  • NO_CARD_PROCESSING — 我们检查数据。
  • NO_CARD_ADD_TO_CAMPAIGN — 将产品放在商店里。

Enum: HAS_CARD_CAN_NOT_UPDATE, HAS_CARD_CAN_UPDATE, HAS_CARD_CAN_UPDATE_ERRORS, HAS_CARD_CAN_UPDATE_PROCESSING, NO_CARD_NEED_CONTENT, NO_CARD_MARKET_WILL_CREATE, NO_CARD_ERRORS, NO_CARD_PROCESSING, NO_CARD_ADD_TO_CAMPAIGN

Min items: 1

Unique items  

categoryIds

Type: integer[]

在市场上按类别过滤。

Min value (exclusive): 0

Min items: 1

Unique items  

offerIds

Type: string[]

需要信息的产品的Id。

此列表仅完整返回。

如果你要求提供特定的资料 SKU,不填写:

  • page_token;
  • limit;
  • cardStatuses;
  • categoryIds;
  • vendorNames;
  • tags;
  • archived.


你的 SKU — 系统中的产品ID。

使用规则 SKU:

  • 对于每个产品 SKU 一定有一个。

  • 已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。

SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Min items: 1

Max items: 200

Unique items  

tags

Type: string[]

按标签过滤。

Min items: 1

Unique items  

vendorNames

Type: string[]

按品牌过滤。

Min items: 1

Unique items  

Responses

200 OK

目录中有关产品的信息。

Body

application/json
{
    "status": "OK",
    "result": {
        "paging": {
            "nextPageToken": "string",
            "prevPageToken": "string"
        },
        "offerMappings": [
            {
                "offer": {
                    "offerId": "string",
                    "name": "Ударная дрель Makita HP1630, 710 Вт",
                    "marketCategoryId": 0,
                    "category": "string",
                    "pictures": [
                        "string"
                    ],
                    "videos": [
                        "string"
                    ],
                    "manuals": [
                        {
                            "url": "string",
                            "title": "string"
                        }
                    ],
                    "vendor": "LEVENHUK",
                    "barcodes": [
                        "46012300000000"
                    ],
                    "description": "string",
                    "manufacturerCountries": [
                        "Россия"
                    ],
                    "weightDimensions": {
                        "length": 65.55,
                        "width": 50.7,
                        "height": 20,
                        "weight": 1.001
                    },
                    "vendorCode": "VNDR-0005A",
                    "tags": [
                        "до 500 рублей"
                    ],
                    "shelfLife": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "lifeTime": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "guaranteePeriod": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "customsCommodityCode": "8517610008",
                    "commodityCodes": [
                        {
                            "code": "string",
                            "type": "CUSTOMS_COMMODITY_CODE"
                        }
                    ],
                    "certificates": [
                        "string"
                    ],
                    "boxCount": 0,
                    "condition": {
                        "type": "PREOWNED",
                        "quality": "PERFECT",
                        "reason": "string"
                    },
                    "type": "DEFAULT",
                    "downloadable": false,
                    "adult": false,
                    "age": {
                        "value": 0,
                        "ageUnit": "YEAR"
                    },
                    "params": [
                        {
                            "name": "Wi-Fi",
                            "value": "есть"
                        }
                    ],
                    "basicPrice": {
                        "value": 0,
                        "currencyId": "RUR",
                        "discountBase": 0,
                        "updatedAt": "2022-12-29T18:02:01Z"
                    },
                    "purchasePrice": {
                        "value": 0,
                        "currencyId": "RUR",
                        "updatedAt": "2022-12-29T18:02:01Z"
                    },
                    "additionalExpenses": {
                        "value": 0,
                        "currencyId": "RUR",
                        "updatedAt": "2022-12-29T18:02:01Z"
                    },
                    "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
                    "campaigns": [
                        {
                            "campaignId": 0,
                            "status": "PUBLISHED"
                        }
                    ],
                    "sellingPrograms": [
                        {
                            "sellingProgram": "FBY",
                            "status": "FINE"
                        }
                    ],
                    "mediaFiles": {
                        "firstVideoAsCover": false,
                        "videos": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ],
                        "pictures": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ],
                        "manuals": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ]
                    },
                    "archived": false,
                    "groupId": "string"
                },
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "showcaseUrls": [
                    {
                        "showcaseType": "B2B",
                        "showcaseUrl": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

status*

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

result

Type: object

offerMappings*

Type: object[]

有关产品的信息。
产品信息。

paging

Type: object

nextPageToken

Type: string

下一个结果页面的ID。

prevPageToken

Type: string

上一个结果页面的ID。

有关结果页的信息。
下一页的ID。

有关产品的信息。

400 Bad Request

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

401 Unauthorized

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

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

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

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

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