Получение информации об отгрузках
Возвращает информацию об отгрузках по заданным параметрам:
- дате;
- статусу;
- идентификаторам заказов.
Результаты возвращаются постранично.
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
PUT
https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
|
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"dateFrom": "string",
"dateTo": "string",
"statuses": [
"OUTBOUND_CREATED"
],
"orderIds": [
0
]
}
|
Name |
Type |
Description |
|
dateFrom |
string<date> |
Начальная дата для фильтрации по дате отгрузки (включительно). Формат даты: |
|
dateTo |
string<date> |
Конечная дата для фильтрации по дате отгрузки (включительно). Формат даты: |
|
statuses |
Список статусов отгрузок. |
|
|
orderIds |
integer<int64>[] |
Список идентификаторов заказов из отгрузок. |
ShipmentStatusType
Статус отгрузки:
OUTBOUND_CREATED— формируется.OUTBOUND_READY_FOR_CONFIRMATION— можно обрабатывать.OUTBOUND_CONFIRMED— подтверждена и готова к отправке.OUTBOUND_SIGNED— по ней подписан электронный акт приема-передачи.ACCEPTED— принята в сортировочном центре или пункте приема.ACCEPTED_WITH_DISCREPANCIES— принята с расхождениями.FINISHED— завершена.ERROR— отменена из-за ошибки.
|
Type |
Description |
|
Enum: |
Responses
200 OK
Найденные отгрузки
Body
{
"status": "OK",
"result": {
"shipments": [
{
"id": 0,
"planIntervalFrom": "2022-12-29T18:02:01Z",
"planIntervalTo": "2022-12-29T18:02:01Z",
"shipmentType": "IMPORT",
"externalId": "string",
"status": "OUTBOUND_CREATED",
"statusDescription": "string",
"deliveryService": {
"id": 0,
"name": "string"
},
"draftCount": 0,
"plannedCount": 0,
"factCount": 0
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
result |
Информация об отгрузках. |
ApiResponseStatusType
Тип ответа.
|
Type |
Description |
|
Enum: |
SearchShipmentsResponseDTO
Информация об отгрузках.
|
Name |
Type |
Description |
|
shipments |
Список с информацией об отгрузках. |
|
|
paging |
Страницы с результатами поиска. |
ShipmentInfoDTO
Список с информацией об отгрузках.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор отгрузки. |
|
planIntervalFrom |
string<date-time> |
Начало планового интервала отгрузки. |
|
planIntervalTo |
string<date-time> |
Конец планового интервала отгрузки. |
|
shipmentType |
Способ отгрузки заказов. |
|
|
externalId |
string |
Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра |
|
status |
Статус отгрузки. |
|
|
statusDescription |
string |
Описание статуса отгрузки. |
|
deliveryService |
Служба доставки. |
|
|
draftCount |
integer<int32> |
Количество заказов, запланированных к отгрузке. |
|
plannedCount |
integer<int32> |
Количество отгруженных заказов. |
|
factCount |
integer<int32> |
Количество заказов, принятых в сортировочном центре или пункте приема. |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
|
Name |
Type |
Description |
|
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
ShipmentType
Способ отгрузки заказов:
IMPORT— вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.WITHDRAW— вы отгружаете заказы со своего склада курьерам Яндекс Маркета.
|
Type |
Description |
|
Enum: |
DeliveryServiceDTO
Служба доставки.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор службы доставки. |
|
name |
string |
Наименование службы доставки. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа. |
|
|
errors |
Список ошибок. |