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

Info

Console

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

offers-and-cards-management — 商品和卡片管理
offers-and-cards-management:read-only — 查看商品和卡片
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

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

产品卡是否已创建，状态如何。
卡片评级 — 占了多少百分比;
传输的产品特性;
是否有任何与内容相关的错误或警告;
填写卡片的建议。

要获得其他产品特性，请使用该方法 POST v2/businesses/{businessId}/offer-mappings.

⚙️ 限制: 每分钟600个请求

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

每页的值数。

Min value: 1

page_token

Type: string

结果页面的ID。

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

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

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

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
  "offerIds": [
    "example"
  ],
  "cardStatuses": [
    "HAS_CARD_CAN_NOT_UPDATE"
  ],
  "categoryIds": [
    0
  ],
  "withRecommendations": false
}

Name	Description
cardStatuses	Type: string[] \| null 按卡状态过滤。什么是产品卡？ Min items: `1` Unique items: `true` Example `[ "HAS_CARD_CAN_NOT_UPDATE" ]`
categoryIds	Type: integer[] \| null 在市场上按类别过滤。 Min items: `1` Max items: `200` Unique items: `true` Example `[ 0 ]`
offerIds	Type: string[] \| null 需要信息的产品的Id。 ⚠️ 不要在同一时间使用此字段作为基于卡片状态、类别、品牌或标签的过滤器。如果要使用过滤器，请将字段留空。 Min items: `1` Max items: `200` Unique items: `true` Example `[ "example" ]`
withRecommendations	Type: boolean 我是否应该返回填写卡片的建议列表以及卡片中所示类别的产品的平均评级 `marketCategoryId`. 默认值: `false`. 如果需要信息，则传递值 `true`. Default: `false`

Responses

200 OK

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

Body

application/json

{
  "status": "OK",
  "result": {
    "offerCards": [
      {
        "offerId": "example",
        "mapping": {},
        "parameterValues": [
          null
        ],
        "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
        "contentRating": 0,
        "averageContentRating": 0,
        "contentRatingStatus": "UPDATING",
        "recommendations": [
          null
        ],
        "groupId": "example",
        "errors": [
          null
        ],
        "warnings": [
          null
        ]
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

offerCards

Type: object[]

offerId

Type: string

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

使用规则 SKU:

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

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

重要

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

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

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

Example: example

averageContentRating

Type: integer

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

仅当参数返回 withRecommendations 这很重要 true.

cardStatus

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

contentRating

Type: integer

卡的评级。

contentRatingStatus

Type: string

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

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

Enum: UPDATING, ACTUAL

errors

Type: object[]

comment

Type: string

解释。

Example: example

message

Type: string

错误的类型。

Example: example

内容中的错误，阻止产品放置在展示柜中。

Min items: 1

Example

[
  {
    "message": "example",
    "comment": "example"
  }
]

groupId

Type: string

产品组的标识符。

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

如何将产品组合在卡片上

Example: example

mapping

Type: object

All of 2 types

Type: object

marketSku

Type: integer

市场上的产品卡的ID。

Min value: 1

从您的角度来看，市场上适合产品的卡片。要确定相应卡的ID，请使用机柜中的搜索（产品中心 → 目录 → 上传产品).

根据验证结果，市场可以将产品链接到更合适的卡。
Example
```
{
  "marketSku": 1
}
```

Type: object

marketCategoryId	Type: integer 品所属的市场上的类别的ID。如果市场尚未确定产品类别，则可能会在响应中缺失。
marketCategoryName	Type: string 卡在市场上的类别的名称。如果市场尚未确定产品类别，则可能会在响应中缺失。 Example: `example`
marketModelName	Type: string 市场上模型的名称。如果产品尚未链接到卡，则可能不会包含在响应中。 Example: `example`
marketSkuName	Type: string 产品卡的名称。如果产品尚未链接到卡，则可能不会包含在响应中。 Example: `example`

Example

{
  "marketSkuName": "example",
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

目录中有关产品的信息。

Example

{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

parameterValues

Type: object[]

parameterId	Type: integer 特性的标识符。 Min value: `1`
unitId	Type: integer 测量单位的ID。如果没有传递参数 `unitId`，使用默认的测量单位。
value	Type: string 意义。对于类型特征 `ENUM` 发送: 与 `valueId`，如果从目录取值; 没有 `valueId`，如果值是它自己的。 Example: `example`
valueId	Type: integer 值的ID。如果要从从市场接收的可接受值列表中传输值，请务必指定标识符。不要指定您自己的值。仅针对类型特征 `ENUM`.

具有其值的特征列表。

Min items: 1

Example

[
  {
    "parameterId": 1,
    "unitId": 0,
    "valueId": 0,
    "value": "example"
  }
]

recommendations

Type: object[]

type

Type: string

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

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

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

执行建议的百分比。

为某些类型的建议指定:

PICTURE_COUNT.
VIDEO_COUNT.
MAIN.
ADDITIONAL.
DISTINCTIVE.

Min value: 0

Max value: 100

Exclusive max: true

remainingRatingPoints

Type: integer

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

Min value: 1

Max value: 100

填写卡片的建议列表。

仅当参数返回 withRecommendations 这很重要 true.

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

Min items: 1

Example

[
  {
    "type": "HAS_VIDEO",
    "percent": 0,
    "remainingRatingPoints": 1
  }
]

warnings

Type: object[]

comment

Type: string

解释。

Example: example

message

Type: string

错误的类型。

Example: example

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

Min items: 1

Example

[
  {
    "message": "example",
    "comment": "example"
  }
]

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

Example

[
  {
    "offerId": "example",
    "mapping": {
      "marketSku": 1,
      "marketSkuName": "example",
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    },
    "parameterValues": [
      {
        "parameterId": 1,
        "unitId": 0,
        "valueId": 0,
        "value": "example"
      }
    ],
    "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
    "contentRating": 0,
    "averageContentRating": 0,
    "contentRatingStatus": "UPDATING",
    "recommendations": [
      {
        "type": "HAS_VIDEO",
        "percent": 0,
        "remainingRatingPoints": 1
      }
    ],
    "groupId": "example",
    "errors": [
      {
        "message": "example",
        "comment": "example"
      }
    ],
    "warnings": [
      {
        "message": "example",
        "comment": "example"
      }
    ]
  }
]

paging

Type: object

nextPageToken

Type: string

下一个结果页面的ID。

Example: example

下一页的ID。

Example

{
  "nextPageToken": "example"
}

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

Example

{
  "offerCards": [
    {
      "offerId": "example",
      "mapping": {
        "marketSku": 1,
        "marketSkuName": "example",
        "marketModelName": "example",
        "marketCategoryId": 0,
        "marketCategoryName": "example"
      },
      "parameterValues": [
        {
          "parameterId": 1,
          "unitId": 0,
          "valueId": 0,
          "value": "example"
        }
      ],
      "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
      "contentRating": 0,
      "averageContentRating": 0,
      "contentRatingStatus": "UPDATING",
      "recommendations": [
        {
          "type": "HAS_VIDEO",
          "percent": 0,
          "remainingRatingPoints": 1
        }
      ],
      "groupId": "example",
      "errors": [
        {
          "message": "example",
          "comment": "example"
        }
      ],
      "warnings": [
        {
          "message": "example",
          "comment": "example"
        }
      ]
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

Example

{
  "result": {
    "offerCards": [
      {
        "offerId": "example",
        "mapping": {},
        "parameterValues": [
          {}
        ],
        "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
        "contentRating": 0,
        "averageContentRating": 0,
        "contentRatingStatus": "UPDATING",
        "recommendations": [
          {}
        ],
        "groupId": "example",
        "errors": [
          {}
        ],
        "warnings": [
          {}
        ]
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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"
    }
  ]
}

这篇文章是否有用？

获取条形码文件（FBY)

编辑产品类别特征