Получение информации об отгрузке
Возвращает информацию об отгрузке по ее идентификатору.
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
|
shipmentId* |
integer<int64> |
Идентификатор отгрузки. |
Responses
200 OK
Найденная отгрузка
Body
{
"status": "OK",
"result": {
"id": 0,
"planIntervalFrom": "2022-12-29T18:02:01Z",
"planIntervalTo": "2022-12-29T18:02:01Z",
"shipmentType": "IMPORT",
"warehouse": {
"id": 0,
"name": "string",
"address": "string"
},
"warehouseTo": {
"id": 0,
"name": "string",
"address": "string"
},
"externalId": "string",
"deliveryService": {
"id": 0,
"name": "string"
},
"palletsCount": {
"planned": 0,
"fact": 0
},
"orderIds": [
0
],
"draftCount": 0,
"plannedCount": 0,
"factCount": 0,
"currentStatus": {
"status": "OUTBOUND_CREATED",
"description": "string",
"updateTime": "2022-12-29T18:02:01Z"
},
"availableActions": [
"CONFIRM"
]
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Информация об отгрузке. |
ShipmentDTO
Информация об отгрузке.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор отгрузки. |
|
planIntervalFrom |
string<date-time> |
Начало планового интервала отгрузки. |
|
planIntervalTo |
string<date-time> |
Конец планового интервала отгрузки. |
|
shipmentType |
Способ отгрузки заказов.
|
|
|
warehouse |
Данные о складе отправления. |
|
|
warehouseTo |
Данные о складе назначения. |
|
|
externalId |
string |
Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра |
|
deliveryService |
Служба доставки. |
|
|
palletsCount |
Данные о палетах в отгрузке. |
|
|
orderIds |
integer<int64>[] |
Идентификаторы заказов в отгрузке. |
|
draftCount |
integer<int32> |
Количество заказов, запланированных к отгрузке. |
|
plannedCount |
integer<int32> |
Количество отгруженных заказов. |
|
factCount |
integer<int32> |
Количество заказов, принятых в сортировочном центре или пункте приема. |
|
currentStatus |
Статус отгрузки. |
|
|
availableActions |
Доступные действия над отгрузкой.
|
ShipmentType
Способ отгрузки заказов:
IMPORT— вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.WITHDRAW— вы отгружаете заказы со своего склада курьерам Яндекс Маркета.
|
Type |
Description |
|
Enum: |
PartnerShipmentWarehouseDTO
Данные о складе отправления.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор склада отправления. |
|
name |
string |
Наименование склада отправления. |
|
address |
string |
Адрес склада отправления. |
DeliveryServiceDTO
Служба доставки.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор службы доставки. |
|
name |
string |
Наименование службы доставки. |
PalletsCountDTO
Количество палет в отгрузке.
|
Name |
Type |
Description |
|
planned |
integer<int32> |
Количество палет, которое заявил продавец. |
|
fact |
integer<int32> |
Количество палет, которое приняли в сортировочном центре. |
ShipmentStatusChangeDTO
Статус отгрузки.
|
Name |
Type |
Description |
|
status |
Статус отгрузки.
|
|
|
description |
string |
Описание статуса отгрузки. |
|
updateTime |
string<date-time> |
Время последнего изменения статуса отгрузки. |
ShipmentActionType
Действия с отгрузкой:
CONFIRM— подтвердить отгрузку.DOWNLOAD_ACT— скачать акт приема-передачи отгрузки.DOWNLOAD_INBOUND_ACT— скачать список принятых заказов.DOWNLOAD_DISCREPANCY_ACT— скачать акт о расхождениях.CHANGE_PALLETS_COUNT— указать количество палет.
|
Type |
Description |
|
Enum: |
ShipmentStatusType
Статус отгрузки:
OUTBOUND_CREATED— формируется.OUTBOUND_READY_FOR_CONFIRMATION— можно обрабатывать.OUTBOUND_CONFIRMED— подтверждена и готова к отправке.OUTBOUND_SIGNED— по ней подписан электронный акт приема-передачи.ACCEPTED— принята в сортировочном центре или пункте приема.ACCEPTED_WITH_DISCREPANCIES— принята с расхождениями.FINISHED— завершена.ERROR— отменена из-за ошибки.
|
Type |
Description |
|
Enum: |
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 |
Список ошибок. |