订单中盒子的现成标签‑贴纸
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- inventory-and-order-processing — 订单处理和商品核算
- all-methods — 全面管理账户
为订单中的盒子生成标签贴纸,并将标签返回到 PDF-文件。
要在标签上显示外部订单ID,请在方法中传递 POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.
| ⚙️ 限制: 每小时100,000次请求 |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Path parameters
|
Name |
Description |
|
boxId* |
Type: integer<int64> 箱的ID。 |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
|
orderId* |
Type: integer<int64> 的订单ID。 |
|
shipmentId* ⦸
|
Type: integer<int64> 传递任何数字以获得正确的数字。 URL. 货物位置ID。 |
Query parameters
|
Name |
Description |
|
format |
Type: PageFormatType 设置快捷方式在页面上的位置。 如果没有参数,则返回 PDF 带格式标签 A7. |
PageFormatType
在页面上放置标签 PDF-档案:
-
A9_HORIZONTALLY— 标签尺寸为58×40mm,无边距,接近格式 A9.市场卖家的标签示例

市场Yandex Go卖家的捷径示例

-
A9— 标签尺寸为40x58mm,无边距,接近A9格式。市场卖家的标签示例

市场Yandex Go卖家的捷径示例

-
A7— 标签为75×120mm(包括边距在内的80.4×125.6mm),接近格式 A7.市场卖家的标签示例

市场Yandex Go卖家的捷径示例

-
A4— 在A4工作表上有一个在市场上卖方办公室选择的格式标签。 — 转到页面 命令 → 订单及付运 →在所需工作模型的选项卡上,单击 标签格式.
|
Type |
Description |
|
Enum: |
Responses
200 OK
PDF-带有盒子标签的文件。 该文件包含一个带有快捷方式的页面。
Body
application/pdf
Type: string
Format: binary
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 错误的描述。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
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: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
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.