Информация на ярлыках‑наклейках
Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.
| ⚙️ Лимит: 1 000 000 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
|
orderId* |
integer<int64> |
Идентификатор заказа. |
Responses
200 OK
Информация для печати ярлыков.
Body
{
"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 |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Данные для печати ярлыка. |
OrderLabelDTO
Данные для печати ярлыка.
|
Name |
Type |
Description |
|
orderId* |
integer<int64> |
Идентификатор заказа. |
|
placesNumber* |
integer<int32> |
Количество коробок в заказе. |
|
url* |
string |
URL файла с ярлыками‑наклейками на все коробки в заказе. Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/labels. |
|
parcelBoxLabels* |
Информация на ярлыке. |
ParcelBoxLabelDTO
Информация о ярлыке для коробки.
|
Name |
Type |
Description |
|
url* |
string |
Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label. |
|
supplierName* |
string |
Юридическое название магазина. |
|
deliveryServiceName* |
string |
Юридическое название службы доставки. |
|
orderId* |
integer<int64> |
Идентификатор заказа в системе Маркета. |
|
orderNum* |
string |
Идентификатор заказа в информационной системе магазина. Совпадает с |
|
recipientName* |
string |
Фамилия и инициалы получателя заказа. |
|
boxId* |
integer<int64> |
Идентификатор коробки. |
|
fulfilmentId* |
string |
Идентификатор коробки в информационной системе магазина. Возвращается в формате: |
|
place* |
string |
Номер коробки в заказе. Возвращается в формате: |
|
weight* |
string |
Устаревший параметр. Общая масса всех товаров в заказе. Возвращается в формате: |
|
deliveryServiceId* |
string |
Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
deliveryAddress |
string |
Адрес получателя. |
|
shipmentDate |
string |
Дата отгрузки в формате |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |