Готовый ярлык‑наклейка для коробки в заказе

Метод доступен для моделей: FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.

Чтобы на ярлыке отображался внешний идентификатор заказа, передайте его в методе POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.

⚙️ Лимит: 100 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label

Path parameters

Name

Description

boxId

Type: integer

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

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

orderId

Type: integer

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

shipmentId

Type: integer

Передайте любое число, чтобы получился корректный URL.

Идентификатор грузового места.

Query parameters

Name

Description

format

Type: PageFormatType

Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Размещение ярлыков на странице PDF-файла:

  • A9_HORIZONTALLY — ярлык размером 58 × 40 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение горизонтального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение горизонтального ярлыка формата A9 для продавцов Market Yandex Go

  • A9 — ярлык размером 40 × 58 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение вертикального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение вертикального ярлыка формата A9 для продавцов Market Yandex Go

  • A7 — ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей), близок к формату A7.

    Пример ярлыка для продавцов Маркета

    Изображение ярлыка формата A7 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение ярлыка формата A7 для продавцов Market Yandex Go

  • A4 — на листе A4 располагается ярлык того формата, который выбран в кабинете продавца на Маркете — перейдите на страницу Заказы → Заказы и отгрузки → на вкладке нужной модели работы нажмите кнопку Формат ярлыков.

Enum: A9_HORIZONTALLY, A9, A7, A4

PageFormatType

Размещение ярлыков на странице PDF-файла:

  • A9_HORIZONTALLY — ярлык размером 58 × 40 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение горизонтального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение горизонтального ярлыка формата A9 для продавцов Market Yandex Go

  • A9 — ярлык размером 40 × 58 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение вертикального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение вертикального ярлыка формата A9 для продавцов Market Yandex Go

  • A7 — ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей), близок к формату A7.

    Пример ярлыка для продавцов Маркета

    Изображение ярлыка формата A7 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение ярлыка формата A7 для продавцов Market Yandex Go

  • A4 — на листе A4 располагается ярлык того формата, который выбран в кабинете продавца на Маркете — перейдите на страницу Заказы → Заказы и отгрузки → на вкладке нужной модели работы нажмите кнопку Формат ярлыков.

Type: string

Enum: A9_HORIZONTALLY, A9, A7, A4

Responses

200 OK

PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком.

Body

application/pdf

Type: string

Format: binary

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
  {
    "code": "example",
    "message": "example"
  }
]
    Example
    {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}
Example
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

No longer supported, please use an alternative and newer version.

Предыдущая
Фактический акт приема-передачи
Следующая
Готовые ярлыки для одного заказа