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

Info

Console

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

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

inventory-and-order-processing — Обработка заказов и учёт товаров
all-methods — Полное управление кабинетом

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

⚙️ Лимит: 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<int64> Идентификатор коробки.
campaignId*	Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. Min value: `1`
orderId*	Type: integer<int64> Идентификатор заказа.
shipmentId* ⦸	Type: integer<int64> Передайте любое число, чтобы получился корректный URL. Идентификатор грузоместа.

Query parameters

Name

Description

format

Type: PageFormatType

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

PageFormatType

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

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

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

Пример ярлыка для продавцов Market Yandex Go
A9 — ярлык размером 40 × 58 мм без полей, близок к формату A9.

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

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

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

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

Type	Description
PageFormatType	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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

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

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

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

Фактический акт приема-передачи

Готовые ярлыки для одного заказа