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

方法适用于模式：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 并且请求有参数 page 和 pageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

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

Name

Description

cardStatuses

Type: OfferCardStatusType[]

按卡状态过滤。

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

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

在市场上按类别过滤。
市场上的类别的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 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助.

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

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

Min items: 1

Max items: 200

Unique items  

OfferCardStatusType

产品卡状态:

  • 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 — 将产品放在商店里。

Type

Description

OfferCardStatusType

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

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: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

result

Type: OfferCardsContentStatusDTO

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

ApiResponseStatusType

响应的类型。 可能的值:

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OfferCardsContentStatusDTO

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

Name

Description

offerCards*

Type: OfferCardDTO[]

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

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

paging

Type: ForwardScrollingPagerDTO

下一页的ID。

OfferCardDTO

品卡的状态的信息。

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

Name

Description

offerId*

Type: string

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

使用规则 SKU:

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

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

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

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

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

averageContentRating

Type: integer<int32>

该卡对该类别产品的平均评级 marketCategoryId.

cardStatus

Type: OfferCardStatusType

产品卡状态:

  • 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

contentRating

Type: integer<int32>

卡的评级。

contentRatingStatus

Type: OfferCardContentStatusType

Статус вычисления рейтинга карточки и рекомендаций.

Enum: UPDATING, ACTUAL

errors

Type: OfferErrorDTO[]

内容中的错误，使产品无法放置在展示柜中。
与产品放置相关的错误消息。

Min items: 1

groupId

Type: string

产品组的标识符。

组合在一起的产品将具有相同的标识符。

如何将产品组合在卡片上

mapping

Type: GetMappingDTO

Основная информация о карточке товара.
Идентификатор карточки на Маркете. Показывает текущую привязку товара к карточке.

Может отсутствовать в ответе, если товар еще не привязан к карточке. Проверьте статус карточки или исправьте ошибки.

parameterValues

Type: ParameterValueDTO[]

具有其值的特征列表。
特性的值。

您可以为同一特性指定多个值，前提是:

要做到这一点，在 parameterValues 分别传递每个值 — 带参数的多个对象 parameterId, valueId 和 value. 参数 parameterId 它必须是相同的。

Min items: 1

recommendations

Type: OfferCardRecommendationDTO[]

填写卡片的建议列表。

燕基科斯.市场建议可帮助您填写卡片，以便客户更容易找到您的产品并决定购买。
填写产品卡的建议。

Min items: 1

warnings

Type: OfferErrorDTO[]

与内容相关的警告，不会阻止产品被放置在展示柜中。
与产品放置相关的错误消息。

Min items: 1

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

OfferCardContentStatusType

计算产品卡和建议的评级的状态:

  • UPDATING — 评级被更新。
  • ACTUAL — 额定值为电流。

Type

Description

OfferCardContentStatusType

Enum: UPDATING, ACTUAL

OfferErrorDTO

与产品放置相关的错误消息。

Name

Description

comment

Type: string

解释。

message

Type: string

错误的类型。

GetMappingDTO

目录中有关产品的信息。

Name

Description

marketCategoryId

Type: integer<int64>

产品所在市场上的类别的ID。

如果市场尚未确定产品类别，则可能会在响应中遗漏。

marketCategoryName

Type: string

卡的类别在市场上的名称。

如果市场尚未确定产品类别，则可能会在响应中遗漏。

marketModelId

⦸

Type: integer<int64>

市场上模型的ID。

如果产品尚未链接到卡，则可能不会包含在响应中。

marketModelName

⦸

Type: string

市场上型号的名称。

如果产品尚未链接到卡，则可能不会包含在响应中。

marketSku

Type: integer<int64>

Идентификатор карточки на Маркете.

Min value: 1

marketSkuName

Type: string

产品卡的名称。

如果产品尚未链接到卡，则可能不会包含在响应中。

ParameterValueDTO

特性的值。

您可以为同一特性指定多个值，前提是:

要做到这一点，在 parameterValues 分别传递每个值 — 带参数的多个对象 parameterId, valueId 和 value. 参数 parameterId 它必须是相同的。

Name

Description

parameterId*

Type: integer<int64>

特性的标识符。

Min value: 1

unitId

Type: integer<int64>

测量单位的ID。 如果没有传递参数 unitId，使用默认的测量单位。

value

Type: string

意义。

对于类型特征 ENUM 与...... valueId.

valueId

Type: integer<int64>

值的ID。

如果要从从市场接收的可接受值列表中传输值，请务必指定标识符。

与...... value.

仅针对类型特征 ENUM.

OfferCardRecommendationDTO

填写产品卡的建议。

Name

Description

type*

Type: OfferCardRecommendationType

添加或替换内容的建议。 对于充斥市场或包含二手商品的卡片，不予退款。

其中一些建议涉及任何类别的产品所具有的基本参数。 其他 — 对那些 特征 该产品因为属于某一类而具有的。

1. 与主要参数相关的建议

每个这样的建议是指单个参数。 要填写此参数，请使用请求 POST v2/businesses/{businessId}/offer-mappings/update.

填写参数的建议 updateOfferMappings:

  • RECOGNIZED_VENDOR — 写制造商的名字就像制造商自己写的那样（参数 vendor).

  • PICTURE_COUNT — 添加图像（参数 pictures). 要求

    其完成的百分比发送的建议。

  • FIRST_PICTURE_SIZE— 用较大的图像替换第一个图像（参数 pictures). 要求

  • TITLE_LENGTH — 更改名称（参数 name). 根据方案制作名称：类型+品牌或制造商+型号+功能，如果有的话（尺寸，重量，颜色）。 要求

  • DESCRIPTION_LENGTH — 添加建议大小的描述（参数 description). 要求

  • AVERAGE_PICTURE_SIZE — 用高质量图像替换所有图像（参数 pictures). 要求

  • FIRST_VIDEO_LENGTH — 添加推荐长度的第一个视频（参数 videos). 要求

  • FIRST_VIDEO_SIZE — 将第一个视频替换为高质量视频（参数 videos). 要求

  • AVERAGE_VIDEO_SIZE — 用高质量视频替换所有视频（参数 videos). 要求

  • VIDEO_COUNT — 添加至少一个视频（参数 videos). 要求

    其完成的百分比发送的建议。

2. 与按类别划分的特征有关的建议

每个这样的建议都需要填写一个或多个特征**。 要确切了解您需要填写哪些特征，请使用请求 POST v2/category/{categoryId}/parameters. 例如，如果您收到了推荐 MAIN，您需要填写具有的特征 MAIN 在阵列中 recommendationTypes.

建议:

  • MAIN — 填写搜索和筛选器中使用的关键产品特征。

    其完成的百分比发送的建议。

  • ADDITIONAL — 填写其他产品规格。

    其完成的百分比发送的建议。

  • DISTINCTIVE — 填写将产品选项彼此区分的特征。

    其完成的百分比发送的建议。

3. 过时的建议

  • HAS_VIDEO.
  • FILTERABLE.
  • HAS_DESCRIPTION.
  • HAS_BARCODE.

Enum: HAS_VIDEO, RECOGNIZED_VENDOR, MAIN, ADDITIONAL, DISTINCTIVE, FILTERABLE, PICTURE_COUNT, HAS_DESCRIPTION, HAS_BARCODE, FIRST_PICTURE_SIZE, TITLE_LENGTH, DESCRIPTION_LENGTH, AVERAGE_PICTURE_SIZE, FIRST_VIDEO_SIZE, FIRST_VIDEO_LENGTH, AVERAGE_VIDEO_SIZE, VIDEO_COUNT

percent

Type: integer<int32>

执行建议的百分比。

为某些类型的建议指定:

  • PICTURE_COUNT.
  • VIDEO_COUNT.
  • MAIN.
  • ADDITIONAL.
  • DISTINCTIVE.

Min value: 0

Max value (exclusive): 100

remainingRatingPoints

Type: integer<int32>

以下建议可获得的卡评级点的最大数量。

Min value: 1

Max value: 100

OfferCardRecommendationType

添加或替换内容的建议。 对于充斥市场或包含二手商品的卡片，不予退款。

其中一些建议涉及任何类别的产品所具有的基本参数。 其他 — 对那些 特征 该产品因为属于某一类而具有的。

1. 与主要参数相关的建议

每个这样的建议是指单个参数。 要填写此参数，请使用请求 POST v2/businesses/{businessId}/offer-mappings/update.

填写参数的建议 updateOfferMappings:

  • RECOGNIZED_VENDOR — 写制造商的名字就像制造商自己写的那样（参数 vendor).

  • PICTURE_COUNT — 添加图像（参数 pictures). 要求

    其完成的百分比发送的建议。

  • FIRST_PICTURE_SIZE— 用较大的图像替换第一个图像（参数 pictures). 要求

  • TITLE_LENGTH — 更改名称（参数 name). 根据方案制作名称：类型+品牌或制造商+型号+功能，如果有的话（尺寸，重量，颜色）。 要求

  • DESCRIPTION_LENGTH — 添加建议大小的描述（参数 description). 要求

  • AVERAGE_PICTURE_SIZE — 用高质量图像替换所有图像（参数 pictures). 要求

  • FIRST_VIDEO_LENGTH — 添加推荐长度的第一个视频（参数 videos). 要求

  • FIRST_VIDEO_SIZE — 将第一个视频替换为高质量视频（参数 videos). 要求

  • AVERAGE_VIDEO_SIZE — 用高质量视频替换所有视频（参数 videos). 要求

  • VIDEO_COUNT — 添加至少一个视频（参数 videos). 要求

    其完成的百分比发送的建议。

2. 与按类别划分的特征有关的建议

每个这样的建议都需要填写一个或多个特征**。 要确切了解您需要填写哪些特征，请使用请求 POST v2/category/{categoryId}/parameters. 例如，如果您收到了推荐 MAIN，您需要填写具有的特征 MAIN 在阵列中 recommendationTypes.

建议:

  • MAIN — 填写搜索和筛选器中使用的关键产品特征。

    其完成的百分比发送的建议。

  • ADDITIONAL — 填写其他产品规格。

    其完成的百分比发送的建议。

  • DISTINCTIVE — 填写将产品选项彼此区分的特征。

    其完成的百分比发送的建议。

3. 过时的建议

  • HAS_VIDEO.
  • FILTERABLE.
  • HAS_DESCRIPTION.
  • HAS_BARCODE.

Type

Description

OfferCardRecommendationType

Enum: HAS_VIDEO, RECOGNIZED_VENDOR, MAIN, ADDITIONAL, DISTINCTIVE, FILTERABLE, PICTURE_COUNT, HAS_DESCRIPTION, HAS_BARCODE, FIRST_PICTURE_SIZE, TITLE_LENGTH, DESCRIPTION_LENGTH, AVERAGE_PICTURE_SIZE, FIRST_VIDEO_SIZE, FIRST_VIDEO_LENGTH, AVERAGE_VIDEO_SIZE, VIDEO_COUNT

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

401 Unauthorized

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

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

上一篇
获取条形码文件（FBY)
下一篇
编辑产品类别特征