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

Info

Console

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

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

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

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

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

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET v2/reports/info/{reportId}.

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

Request

POST

https://api.partner.market.yandex.ru/v2/reports/documents/labels/generate

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`

Body

application/json

{
    "businessId": 0,
    "orderIds": [
        0
    ],
    "sortingType": "SORT_BY_GIVEN_ORDER"
}

Name	Description
businessId*	Type: integer<int64> Идентификатор кабинета.
orderIds*	Type: integer<int64>[] Список идентификаторов заказов. Идентификатор заказа. Min items: `1` Max items: `1000` Unique items
sortingType	Type: LabelsSortingType Тип сортировки ярлыков в файле. Enum: `SORT_BY_GIVEN_ORDER`, `SORT_BY_ORDER_CREATED_AT`

LabelsSortingType

Тип сортировки ярлыков:

SORT_BY_GIVEN_ORDER — ярлыки заказов будут расположены в том же порядке, в каком были переданы идентификаторы заказов в запросе.
SORT_BY_ORDER_CREATED_AT — ярлыки будут расположены в соответствии с датой создания заказа с группировкой по магазинам.

Если параметр не указан, ярлыки сортируются по дате создания.

Type	Description
LabelsSortingType	Enum: `SORT_BY_GIVEN_ORDER`, `SORT_BY_ORDER_CREATED_AT`

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

Body

application/json

{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GenerateReportDTO

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

ApiResponseStatusType

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

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

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

GenerateReportDTO

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

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

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

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

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

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

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

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