Ярлыки‑наклейки на все коробки в нескольких заказах
Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.
| ⚙️ Лимит: 1000 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/documents/labels/generate
Query parameters
|
Name |
Description |
|
format |
Type: PageFormatType Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. |
PageFormatType
Размещение ярлыков на странице:
A7— в PDF-файле будут страницы формата близкому к A7. На каждой странице размещается ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей).A4— в PDF-файле будут страницы формата A4. На каждой странице размещаются восемь ярлыков размером 70,6 × 99,1 мм без полей.
|
Type |
Description |
|
Enum: |
Body
application/json
{
"businessId": 0,
"orderIds": [
0
]
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> Идентификатор кабинета. |
|
orderIds* |
Type: integer<int64>[] Список идентификаторов заказов. Max items: Min items: Unique items: |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.
Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
result |
Type: GenerateReportDTO Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
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[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
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[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
|
status |
Type: ApiResponseStatusType Тип ответа. Enum: |