订单中盒子的现成标签‑贴纸

方法适用于模式:FBS, 快递DBS.

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

为订单中的盒子生成标签贴纸,并在PDF文件中返回标签。

**⚙️ 限制:**每小时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。

您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

  • 模块和 API→区块 向Yandex发送数据。街市.
  • 查询日志 →块中的下拉列表 显示日志.

,不要发送商店的ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。

Min value: 1

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×40毫米的标签,没有边距,接近格式 A9.

    市场卖家的标签示例

    水平格式标签的图像 A9 市场卖家须知

    市场Yandex Go卖家的捷径示例

    市场Yandex Go卖家的a9格式水平标签的图像

  • A9 -标签尺寸为40x58毫米,无边距,接近A9格式。

    市场卖家的标签示例

    垂直标签格式的图像 A9 市场卖家须知

    市场Yandex Go卖家的捷径示例

    垂直标签格式的图像 A9 对于Yandex Go市场的卖家

  • A7 -标签尺寸75×120毫米(80.4×125.6毫米,包括边距),接近格式 A7.

    市场卖家的标签示例

    市场卖家的A7格式标签的图像

    市场Yandex Go卖家的捷径示例

    格式标签的图像 A7 对于Yandex Go市场的卖家

  • A4 —在A4工作表上有一个在市场上卖方办公室选择的格式的标签-转到页面 命令订单及付运 →在所需工作模型的选项卡上,单击 标签格式.

Type

Description

PageFormatType

Enum: A9_HORIZONTALLY, A9, A7, A4

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

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

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

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

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.