Получение листа сборки
Метод доступен для модели FBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- all-methods — Полное управление кабинетом
Запускает генерацию листа сборки для отгрузки.
Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса GET reports/info/{reportId}.
⚙️ Лимит: 100 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/reports/documents/shipment-list/generate
Body
application/json
{
"campaignId": 0,
"shipmentId": 0,
"orderIds": [
0
]
}
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. |
orderIds |
Type: integer<int64>[] Фильтр по идентификаторам заказа в отгрузке. В запросе обязательно передавайте Min items: Unique items |
shipmentId |
Type: integer<int64> Идентификатор отгрузки. В запросе обязательно передавайте |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый документ.
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 Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
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[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.