自标签生产数据

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

目前不适用于卖家Market Yandex Go.

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

返回订单中粘在盒子上的标签信息。

**⚙️ 限制:**每小时100,000次请求

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

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

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

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

Min value: 1

orderId*

Type: integer<int64>

的订单ID。

Responses

200 OK

用于打印标签的信息。

Body

application/json
{
    "status": "OK",
    "result": {
        "orderId": 0,
        "placesNumber": 0,
        "url": "string",
        "parcelBoxLabels": [
            {
                "url": "string",
                "supplierName": "string",
                "deliveryServiceName": "string",
                "orderId": 0,
                "orderNum": "string",
                "recipientName": "string",
                "boxId": 0,
                "fulfilmentId": "string",
                "place": "string",
                "weight": "string",
                "deliveryServiceId": "string",
                "deliveryAddress": "string",
                "shipmentDate": "string"
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

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

Enum: OK, ERROR

result

Type: OrderLabelDTO

用于打印标签的数据。

ApiResponseStatusType

响应的类型。 可能的值:

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrderLabelDTO

用于打印标签的数据。

Name

Description

orderId*

Type: integer<int64>

的订单ID。

parcelBoxLabels*

Type: ParcelBoxLabelDTO[]

标签上的信息。
盒的标签的信息。

placesNumber*

Type: integer<int32>

顺序的框数。

url*

Type: string

顺序中所有框的带有标签标签的文件的URL。

对应于请求URL。 GET v2/campaigns/{campaignId}/orders/{orderId}/delivery/labels.

Min length: 1

Max length: 2000

ParcelBoxLabelDTO

盒的标签的信息。

Name

Description

boxId*

Type: integer<int64>

箱的ID。

deliveryServiceId*

Type: string

送服务ID。 有关派递服务的资料,可透过要求 GET delivery/services.

deliveryServiceName*

Type: string

送货服务的法定名称。

fulfilmentId*

Type: string

商店信息系统中盒子的ID。

以格式返回: 市场上的订单号是箱号。. 例如, 7206821‑1, 7206821‑2 等等。

orderId*

Type: integer<int64>

市场系统中的订单ID。

orderNum*

Type: string

商店信息系统中的订单ID。

orderId 如果市场不知道商店系统中的订单号。

place*

Type: string

顺序中的箱号。 以格式返回: 座位数/座位总数.

recipientName*

Type: string

订单收件人的姓氏和首字母。

supplierName*

Type: string

商店的法定名称。

url*

Type: string

回应 URL,请求正在执行的 GET v2/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label.

Min length: 1

Max length: 2000

weight*

Type: string

订单中所有物品的总重量。

以格式返回: weight кг.

deliveryAddress

Type: string

收件人的地址。

shipmentDate

Type: string

装运日期的格式 dd.MM.yyyy.

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

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.