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

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

Значение поля type используют в label_format при запросе ярлыков через GET /v1/orders/{id}/delivery-labels.

Дубликаты служб во входном списке игнорируются. Порядок служб в ответе фиксирован платформой — он не алфавитный. Чтобы найти нужную службу, используйте поле delivery_service.

Request

GET

https://api.kit.yandex.net/v1/delivery/label-formats

Query parameters

Name

Description

delivery_service

Type: DeliveryServiceType[]

Службы доставки, для которых нужны размеры ярлыков.

Min items: 1

Example: ``

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

Responses

200 OK

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

Body

application/json
{
  "services": [
    {
      "delivery_service": "YANDEX_DELIVERY",
      "mode": "EXPLICIT_FORMATS",
      "formats": [
        {
          "type": "210x297",
          "title": "A4, 210×297 мм",
          "preselected": true
        }
      ]
    }
  ]
}

Name

Description

services

Type: DeliveryServiceLabelFormats[]

Службы доставки в фиксированном порядке отображения, заданном платформой. Порядок не алфавитный и меняется при добавлении новых служб — поиск службы выполняйте по полю delivery_service.

Example
[
  {
    "delivery_service": "YANDEX_DELIVERY",
    "mode": "EXPLICIT_FORMATS",
    "formats": [
      {
        "type": "210x297",
        "title": "A4, 210×297 мм",
        "preselected": true
      }
    ]
  }
]

DeliveryLabelFormatMode

Как служба доставки работает с размерами ярлыков:

  • EXPLICIT_FORMATS — размер можно выбрать из formats.
  • PROVIDER_DEFAULT — служба печатает в собственном размере, formats пуст.
  • NOT_SUPPORTED — служба не печатает ярлыки, formats пуст.

Type: string

Enum: EXPLICIT_FORMATS, PROVIDER_DEFAULT, NOT_SUPPORTED

DeliveryLabelFormatType

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

Type: string

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

DeliveryLabelFormat

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

Name

Description

preselected

Type: boolean

Размер, предвыбранный в интерфейсе Яндекс KITᵝ, — подсказка для UI.

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

title

Type: string

Название размера для показа пользователю.

Example: A4, 210×297 мм

type

Type: DeliveryLabelFormatType

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

Enum: 210x297, 148x210, 105x148, 100x150, 74x105, 75x120, 120x75, 58x60, 58x40
Example
{
  "type": "210x297",
  "title": "A4, 210×297 мм",
  "preselected": true
}

DeliveryServiceLabelFormats

Размеры ярлыков одной службы доставки.

Name

Description

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

formats

Type: DeliveryLabelFormat[]

Доступные размеры ярлыка. Пуст, если mode не EXPLICIT_FORMATS.

Example
[
  {
    "type": "210x297",
    "title": "A4, 210×297 мм",
    "preselected": true
  }
]

mode

Type: DeliveryLabelFormatMode

Как служба доставки работает с размерами ярлыков:

  • EXPLICIT_FORMATS — размер можно выбрать из formats.
  • PROVIDER_DEFAULT — служба печатает в собственном размере, formats пуст.
  • NOT_SUPPORTED — служба не печатает ярлыки, formats пуст.

Enum: EXPLICIT_FORMATS, PROVIDER_DEFAULT, NOT_SUPPORTED
Example
{
  "delivery_service": "YANDEX_DELIVERY",
  "mode": "EXPLICIT_FORMATS",
  "formats": [
    {
      "type": "210x297",
      "title": "A4, 210×297 мм",
      "preselected": true
    }
  ]
}

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

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
Предыдущая
Список ресурсов
Следующая
Список ресурсов