获取有关存储卡丰满度的信息

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

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

返回有关指定产品的内容状态的信息:

  • 产品卡是否已创建,状态如何。
  • 卡片评级 — 占了多少百分比;
  • 传输的产品特性;
  • 是否有任何与内容相关的错误或警告;
  • 填写卡片的建议。
⚙️ 限制: 每分钟600个请求

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name

Description

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
    ],
    "withRecommendations": false
}

Name

Description

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[]

在市场上按类别过滤。
市场上的类别的ID。

更改类别时,请确保参数中的产品特性及其值 parameterValues 您正在提交一个新的类别.

您可以使用请求获取市场类别列表。 POST v2/categories/tree.

Min value (exclusive): 0

Min items: 1

Max items: 200

Unique items  

offerIds

Type: string[]

需要信息的产品的Id。

⚠️ 不要在同一时间使用此字段作为基于卡片状态、类别、品牌或标签的过滤器。 如果要使用过滤器,请将字段留空。
你的 SKU — 系统中的产品ID。

使用规则 SKU:

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

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

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

重要

值开头和结尾的空格会自动删除。 例如, " SKU123 ""SKU123" 它们将被视为相同的值。

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

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

Min items: 1

Max items: 200

Unique items  

withRecommendations

Type: boolean

我是否应该返回填写卡片的建议列表以及卡片中所示类别的产品的平均评级 marketCategoryId.

默认值: false. 如果需要信息,则传递值 true.

Default: false

Responses

200 OK

有关指定产品的卡片的信息。

Body

application/json
{
    "status": "OK",
    "result": {
        "offerCards": [
            {
                "offerId": "string",
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "parameterValues": [
                    {
                        "parameterId": 0,
                        "unitId": 0,
                        "valueId": 0,
                        "value": "string"
                    }
                ],
                "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
                "contentRating": 0,
                "averageContentRating": 0,
                "contentRatingStatus": "UPDATING",
                "recommendations": [
                    {
                        "type": "HAS_VIDEO",
                        "percent": 0,
                        "remainingRatingPoints": 0
                    }
                ],
                "groupId": "string",
                "errors": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ],
                "warnings": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ]
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

result

Type: object

offerCards*

Type: object[]

产品列表页面,包含有关卡片状态的信息。
品卡的状态的信息。

如果字段 mapping 在回应中缺失,市场尚未设法处理产品信息。 要确定此类项目的类别,请在几分钟内重复请求。

paging

Type: object

nextPageToken

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.