Request
Responses
200 OK
400 Bad Request
- Body
- ApiErrorDTO
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

Получение информации об отгрузках

Info

Console

Возвращает информацию об отгрузках по заданным параметрам:

дате;
статусу;
идентификаторам заказов.

Результаты возвращаются постранично.

⚙️ Лимит: 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 результатами.

Если параметр не указан, возвращается самая старая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token, параметры offset, page_number и page_size игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

limit

integer<int32>

Количество товаров на одной странице.
Example: 20

Body

application/json

{
    "dateFrom": "string",
    "dateTo": "string",
    "statuses": [
        "OUTBOUND_CREATED"
    ],
    "orderIds": [
        0
    ]
}

Name	Type	Description
dateFrom	string<date>	Начальная дата для фильтрации по дате отгрузки (включительно). Формат даты: `ДД-ММ-ГГГГ`.
dateTo	string<date>	Конечная дата для фильтрации по дате отгрузки (включительно). Формат даты: `ДД-ММ-ГГГГ`.
statuses	ShipmentStatusType[]	Список статусов отгрузок. Статус отгрузки Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
orderIds	integer<int64>[]	Список идентификаторов заказов из отгрузок. Идентификатор заказа.

ShipmentStatusType

Статус отгрузки:

OUTBOUND_CREATED — формируется.
OUTBOUND_READY_FOR_CONFIRMATION — можно обрабатывать.
OUTBOUND_CONFIRMED — подтверждена и готова к отправке.
OUTBOUND_SIGNED — по ней подписан электронный акт приема-передачи.
ACCEPTED — принята в сортировочном центре или пункте приема.
ACCEPTED_WITH_DISCREPANCIES — принята с расхождениями.
FINISHED — завершена.
ERROR — отменена из-за ошибки.

Type	Description
ShipmentStatusType	Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`

{
    "status": "OK",
    "result": {
        "shipments": [
            {
                "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,
                "status": "OUTBOUND_CREATED",
                "statusDescription": "string",
                "statusUpdateTime": "2022-12-29T18:02:01Z"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
result	SearchShipmentsResponseDTO	Информация об отгрузках.

ApiResponseStatusType

Тип ответа.

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

SearchShipmentsResponseDTO

Информация об отгрузках.

Name	Type	Description
shipments	ShipmentInfoDTO[]	Список с информацией об отгрузках. Список с информацией об отгрузках. Информация об отгрузке.
paging	ForwardScrollingPagerDTO	Страницы с результатами поиска.

ShipmentInfoDTO

Список с информацией об отгрузках.

Name	Type	Description
id	integer<int64>	Идентификатор отгрузки.
planIntervalFrom	string<date-time>	Начало планового интервала отгрузки.
planIntervalTo	string<date-time>	Конец планового интервала отгрузки.
shipmentType	ShipmentType	Способ отгрузки заказов. Enum: `IMPORT`, `WITHDRAW`
warehouse	PartnerShipmentWarehouseDTO	Данные о складе отправления.
warehouseTo	PartnerShipmentWarehouseDTO	Данные о складе назначения.
externalId	string	Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра `id`.
deliveryService	DeliveryServiceDTO	Служба доставки.
palletsCount	PalletsCountDTO	Данные о палетах в отгрузке.
orderIds	integer<int64>[]	Идентификаторы заказов в отгрузке.
draftCount	integer<int32>	Количество заказов, запланированных к отгрузке.
plannedCount	integer<int32>	Количество отгруженных заказов.
factCount	integer<int32>	Количество заказов, принятых в сортировочном центре или пункте приема.
status	ShipmentStatusType	Статус отгрузки. Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
statusDescription	string	Описание статуса отгрузки.
statusUpdateTime	string<date-time>	Время последнего изменения статуса отгрузки.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name	Type	Description
nextPageToken	string	Идентификатор следующей страницы результатов.

ShipmentType

Способ отгрузки заказов:

IMPORT — вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.
WITHDRAW — вы отгружаете заказы со своего склада курьерам Яндекс Маркета.

Type	Description
ShipmentType	Enum: `IMPORT`, `WITHDRAW`

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>	Количество палет, которое приняли в сортировочном центре.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

ApiErrorDTO

Общий формат ошибки.

Name	Type	Description
code*	string	Код ошибки.
message	string	Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

Получение информации об отгрузках

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

BodyBody

ShipmentStatusTypeShipmentStatusType

ResponsesResponses

200 OK200 OK

BodyBody

ApiResponseStatusTypeApiResponseStatusType

SearchShipmentsResponseDTOSearchShipmentsResponseDTO

ShipmentInfoDTOShipmentInfoDTO

ForwardScrollingPagerDTOForwardScrollingPagerDTO

ShipmentTypeShipmentType

PartnerShipmentWarehouseDTOPartnerShipmentWarehouseDTO

DeliveryServiceDTODeliveryServiceDTO

PalletsCountDTOPalletsCountDTO

400 Bad Request400 Bad Request

BodyBody

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

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

Request

Path parameters

Query parameters

Body

ShipmentStatusType

Responses

200 OK

Body

ApiResponseStatusType

SearchShipmentsResponseDTO

ShipmentInfoDTO

ForwardScrollingPagerDTO

ShipmentType

PartnerShipmentWarehouseDTO

DeliveryServiceDTO

PalletsCountDTO

400 Bad Request

Body

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body