获取条形码文件
方法适用于模式FBY.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- inventory-and-order-processing — 订单处理和商品核算
- all-methods — 全面管理账户
开始生成 PDF-在指定的交付请求中转移的货物或货物的条形码的文件。
如果文件包含超过1,500个条形码,则无法生成该文件。
您可以查找生成状态,并使用请求获取到已完成文件的链接。 GET v2/reports/info/{reportId}.
| ⚙️ 限制: 每小时1,000个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v1/reports/documents/barcodes/generate
Body
application/json
{
"campaignId": 0,
"barcodeFormat": "F_30_20",
"barcodeOfferInfos": [
{
"offerId": "string",
"barcodeCount": 0
}
],
"supplyRequestId": 0
}
|
Name |
Description |
|
barcodeFormat* |
Type: BarcodeFormatType 页面格式和条形码大小:
Enum: |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。 |
|
barcodeOfferInfos |
Type: BarcodeOfferInfoDTO[] 的产品清单。 传递此参数和唯一 请求必须包含 如果有关具有多个条形码的产品的信息被传输,则所有条形码将被添加到文件中,它们的数量将由参数设置 Min items: Max items: |
|
supplyRequestId |
Type: integer<int64> Идентификатор заявки на поставку. Передайте этот параметр, чтобы вернуть файл со штрихкодами товаров в указанной заявке на поставку. Вернутся штрихкоды каждого товара в заявке. В запросе обязательно должен быть либо Min value: |
BarcodeFormatType
页面格式和条形码大小:
F_30_20— A4,30×20毫米条形码。F_43_25— A4,43x25毫米条码。F_58_40— A4,58×40毫米条形码。F_43_25_SINGLE— 用于打印标签。
|
Type |
Description |
|
Enum: |
BarcodeOfferInfoDTO
关于条形码的信息。
|
Name |
Description |
|
barcodeCount* |
Type: integer<int64> 要打印的条形码的数量。 Min value: Max value: |
|
offerId* |
Type: string 你的 SKU — 系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您找出生成状态并下载完成的文件。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GenerateReportDTO 跟踪生成状态和接收完成的报告或文档所需的ID。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
GenerateReportDTO
跟踪生成状态和接收完成的报告或文档所需的ID。
|
Name |
Description |
|
estimatedGenerationTime* |
Type: integer<int64> 以毫秒为单位的预期生成时间。 |
|
reportId* |
Type: string 跟踪生成状态和接收完成的报告或文档所需的ID。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.