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

Info

Console

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всей информации в кабинете

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

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

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

⚙️ Лимит: 100 запросов в час

Request

PUT

https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

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

page_token

Type: string

Идентификатор страницы c результатами.

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

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

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

Body

application/json

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

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

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`

Responses

200 OK

Найденные отгрузки.

Body

application/json

{
    "status": "OK",
    "result": {
        "shipments": [
            {
                "id": 0,
                "planIntervalFrom": "2017-11-21T00:00:00+03:00",
                "planIntervalTo": "2017-11-21T00:00:00+03:00",
                "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": "2017-11-21T00:00:00+03:00"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: SearchShipmentsResponseDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

SearchShipmentsResponseDTO

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

Name

Description

shipments*

Type: ShipmentInfoDTO[]

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

paging

Type: ForwardScrollingPagerDTO

Страницы с результатами поиска.

ApiResponseStatusType

Тип ответа.

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

ShipmentInfoDTO

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

Name	Description
draftCount*	Type: integer<int32> Количество заказов, которое Маркет запланировал к отгрузке. Min value: `0`
factCount*	Type: integer<int32> Количество заказов, принятых в сортировочном центре или пункте приема. Min value: `0`
id*	Type: integer<int64> Идентификатор отгрузки. Min value: `1`
orderIds*	Type: integer<int64>[] Идентификаторы заказов в отгрузке. Min value: `1` Unique items: `true`
planIntervalFrom*	Type: string<date-time> Начало планового интервала отгрузки. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
planIntervalTo*	Type: string<date-time> Конец планового интервала отгрузки. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
plannedCount*	Type: integer<int32> Количество заказов, которое Маркет подтвердил к отгрузке. Min value: `0`
deliveryService	Type: DeliveryServiceDTO Служба доставки.
externalId	Type: string Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра `id`.
palletsCount	Type: PalletsCountDTO Данные о палетах в отгрузке.
shipmentType	Type: ShipmentType Способ отгрузки заказов. Enum: `IMPORT`, `WITHDRAW`
status	Type: ShipmentStatusType Статус отгрузки. Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
statusDescription	Type: string Описание статуса отгрузки.
statusUpdateTime	Type: string<date-time> Время последнего изменения статуса отгрузки Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
warehouse	Type: PartnerShipmentWarehouseDTO Данные о складе отправления.
warehouseTo	Type: PartnerShipmentWarehouseDTO Данные о складе назначения.

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

DeliveryServiceDTO

Служба доставки.

Name

Description

Type: integer<int64>

Идентификатор службы доставки.

name

Type: string

Наименование службы доставки.

PalletsCountDTO

Количество палет в отгрузке.

Name

Description

fact

Type: integer<int32>

Количество палет, которое приняли в сортировочном центре.

Min value: 0

planned

Type: integer<int32>

Количество палет, которое заявил продавец.

Min value: 0

ShipmentType

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

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

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

PartnerShipmentWarehouseDTO

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

Name	Description
id*	Type: integer<int64> Идентификатор склада отправления. Min value: `1`
address	Type: string Адрес склада отправления.
name	Type: string Наименование склада отправления.

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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

Информация об одной отгрузке

Акт приема-передачи