自标签生产数据
目前不适用于卖家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。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
|
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 响应的类型。 可能的值:
Enum: |
|
result |
Type: OrderLabelDTO 用于打印标签的数据。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
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: Max length: |
ParcelBoxLabelDTO
盒的标签的信息。
|
Name |
Description |
|
boxId* |
Type: integer<int64> 箱的ID。 |
|
deliveryServiceId* |
Type: string 送服务ID。 有关派递服务的资料,可透过要求 GET delivery/services. |
|
deliveryServiceName* |
Type: string 送货服务的法定名称。 |
|
fulfilmentId* |
Type: string 商店信息系统中盒子的ID。 以格式返回: |
|
orderId* |
Type: integer<int64> 市场系统中的订单ID。 |
|
orderNum* |
Type: string 商店信息系统中的订单ID。 与 |
|
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: Max length: |
|
weight* ⦸
|
Type: string 订单中所有物品的总重量。 以格式返回 |
|
deliveryAddress |
Type: string 收件人的地址。 |
|
shipmentDate |
Type: string 装运日期的格式 |
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: |
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.