Получение ярлыков доставки заказа

Возвращает ярлыки доставки по частям заказа. Ярлык — это PDF‑файл с адресом, трек‑номером и штрихкодом. Его наклеивают на отправление.

При первом обращении ярлык запрашивают у службы доставки, потом его можно использовать повторно. Повторный запрос по той же части заказа и в том же формате вернет ранее сформированный документ.

Некоторые части заказа не попадают в delivery_labels:

самовывоз;
собственная доставка магазина;
заказ еще не передан в службу доставки. Они перечисляются в skipped c указыванием причины.

Если служба доставки отказала по одной части заказа, остальные не затрагиваются. Проблемную часть переносят в skipped с причиной GENERATION_FAILED, ярлыки для других частей возвращают как обычно. Код 500 означает, что запрос не удалось обработать целиком.

Примечание

Ссылки на ярлыки подписаны и действуют ограниченное время. Момент истечения срока указан в поле expires_at. Не храните ссылку — получите новую сделав повторный запрос.

Request

GET

https://api.kit.yandex.net/v1/orders/{id}/delivery-labels

Query parameters

Name

Description

label_format

Type: DeliveryLabelFormatType

Размер ярлыка задают в миллиметрах. Если размер не передан, служба доставки использует свой формат по умолчанию.

Размеры зависят от службы доставки. Список размеров получают запросом GET /v1/delivery/label-formats. Если служба работает в режиме mode: EXPLICIT_FORMATS и запрошенного размера нет в списке, часть заказа попадает в skipped с причиной FORMAT_NOT_SUPPORTED.

Службы в режиме mode: PROVIDER_DEFAULT не учитывают размер. Они печатают ярлык в своем стандартном размере. Для таких частей в ответе поле label_format будет пустым.

Размер ярлыка доставки в миллиметрах.

Enum: 210x297, 148x210, 105x148, 100x150, 74x105, 75x120, 120x75, 58x60, 58x40

DeliveryLabelFormatType

Размер ярлыка доставки в миллиметрах.

Type: string

Enum: 210x297, 148x210, 105x148, 100x150, 74x105, 75x120, 120x75, 58x60, 58x40

Responses

200 OK

Ярлыки доставки заказа.

Body

application/json

{
  "delivery_labels": [
    {
      "delivery_chunk_id": 1,
      "delivery_service": "YANDEX_DELIVERY",
      "url": "https://example.com/order-labels/550e8400-e29b-41d4-a716-446655440000.pdf?X-Amz-Signature=1234567890",
      "expires_at": "2026-08-18T12:00:00Z",
      "label_format": "210x297"
    }
  ],
  "skipped": [
    {
      "delivery_chunk_id": 1,
      "reason": "SELF_PICKUP"
    }
  ]
}

Name

Description

delivery_labels

Type: OrderDeliveryLabel[]

Сформированные ярлыки доставки.

Example

[
  {
    "delivery_chunk_id": 1,
    "delivery_service": "YANDEX_DELIVERY",
    "url": "https://example.com/order-labels/550e8400-e29b-41d4-a716-446655440000.pdf?X-Amz-Signature=1234567890",
    "expires_at": "2026-08-18T12:00:00Z",
    "label_format": "210x297"
  }
]

skipped

Type: SkippedOrderDeliveryLabel[]

Части заказа, для которых ярлык не сформирован.

Example

[
  {
    "delivery_chunk_id": 1,
    "reason": "SELF_PICKUP"
  }
]

DeliveryServiceType

Служба доставки:

YANDEX_DELIVERY — Яндекс Доставка.
CDEK — СДЭК.
META_SHIP_DALLI — Dalli через MetaShip.
META_SHIP_RUSSIAN_POST — Почта России через MetaShip.
META_SHIP_PECOM — ПЭК через MetaShip.
OZON — Ozon Доставка.
MERCHANT_SHIP — собственная служба доставки магазина.
YANDEX_MARKET_FBO — Фулфилмент Яндекс Маркета.

Type: string

Enum: YANDEX_DELIVERY, CDEK, META_SHIP_DALLI, META_SHIP_RUSSIAN_POST, META_SHIP_PECOM, OZON, MERCHANT_SHIP, YANDEX_MARKET_FBO

OrderDeliveryLabel

Ярлык доставки одной части заказа.

Name	Description
delivery_chunk_id	Type: integer Идентификатор чанка заказа.
delivery_service	Type: DeliveryServiceType Служба доставки: `YANDEX_DELIVERY` — Яндекс Доставка. `CDEK` — СДЭК. `META_SHIP_DALLI` — Dalli через MetaShip. `META_SHIP_RUSSIAN_POST` — Почта России через MetaShip. `META_SHIP_PECOM` — ПЭК через MetaShip. `OZON` — Ozon Доставка. `MERCHANT_SHIP` — собственная служба доставки магазина. `YANDEX_MARKET_FBO` — Фулфилмент Яндекс Маркета. Enum: `YANDEX_DELIVERY`, `CDEK`, `META_SHIP_DALLI`, `META_SHIP_RUSSIAN_POST`, `META_SHIP_PECOM`, `OZON`, `MERCHANT_SHIP`, `YANDEX_MARKET_FBO`
expires_at	Type: string<date-time> Момент, после которого ссылка перестает работать. Example: `2026-08-18T12:00:00Z`
url	Type: string<uri> Подписанная ссылка на PDF-файл с ярлыком. Example: `https://example.com/order-labels/550e8400-e29b-41d4-a716-446655440000.pdf?X-Amz-Signature=1234567890`
label_format	Type: DeliveryLabelFormatType Размер ярлыка доставки в миллиметрах. Enum: `210x297`, `148x210`, `105x148`, `100x150`, `74x105`, `75x120`, `120x75`, `58x60`, `58x40`

Example

{
  "delivery_chunk_id": 1,
  "delivery_service": "YANDEX_DELIVERY",
  "url": "https://example.com/order-labels/550e8400-e29b-41d4-a716-446655440000.pdf?X-Amz-Signature=1234567890",
  "expires_at": "2026-08-18T12:00:00Z",
  "label_format": "210x297"
}

SkippedOrderDeliveryLabelReason

Причина, по которой ярлык не сформирован:

SELF_PICKUP — самовывоз, отправления нет и ярлык не нужен.
DELIVERY_NOT_CREATED — доставка еще не создана в службе доставки, трек-номера нет.
SERVICE_NOT_SUPPORTED — служба доставки не печатает ярлыки (собственная доставка магазина и часть служб).
FORMAT_NOT_SUPPORTED — служба доставки печатает по списку размеров и запрошенного label_format среди них нет. Службы с mode: PROVIDER_DEFAULT этой причины не дают: они игнорируют label_format и печатают в своем размере.
GENERATION_FAILED — служба доставки не отдала ярлык (ошибка или таймаут на ее стороне). Причина временная: повторите запрос позже. Остальные части заказа при этом возвращаются в delivery_labels.

Type: string

Enum: SELF_PICKUP, DELIVERY_NOT_CREATED, SERVICE_NOT_SUPPORTED, FORMAT_NOT_SUPPORTED, GENERATION_FAILED

SkippedOrderDeliveryLabel

Часть заказа, для которой ярлык не сформирован.

Name

Description

delivery_chunk_id

Type: integer

Идентификатор чанка заказа.

reason

Type: SkippedOrderDeliveryLabelReason

Причина, по которой ярлык не сформирован:

SELF_PICKUP — самовывоз, отправления нет и ярлык не нужен.
DELIVERY_NOT_CREATED — доставка еще не создана в службе доставки, трек-номера нет.
SERVICE_NOT_SUPPORTED — служба доставки не печатает ярлыки (собственная доставка магазина и часть служб).
FORMAT_NOT_SUPPORTED — служба доставки печатает по списку размеров и запрошенного label_format среди них нет. Службы с mode: PROVIDER_DEFAULT этой причины не дают: они игнорируют label_format и печатают в своем размере.
GENERATION_FAILED — служба доставки не отдала ярлык (ошибка или таймаут на ее стороне). Причина временная: повторите запрос позже. Остальные части заказа при этом возвращаются в delivery_labels.

Enum: SELF_PICKUP, DELIVERY_NOT_CREATED, SERVICE_NOT_SUPPORTED, FORMAT_NOT_SUPPORTED, GENERATION_FAILED

Example

{
  "delivery_chunk_id": 1,
  "reason": "SELF_PICKUP"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Завершение доставки заказа

Запись кодов маркировки «Честный знак»