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

Info

Console

Метод доступен для модели FBS.

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

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина в кабинете.

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

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

Min value: 1

shipmentId*

Type: integer<int64>

Идентификатор отгрузки.

Min value: 1

Query parameters

Name

Description

cancelledOrders

Type: boolean

Возвращать ли отмененные заказы.

Значение по умолчанию: true. Если возвращать отмененные заказы не нужно, передайте значение false.

Default: true

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "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,
        "signature": {
            "signed": false
        },
        "currentStatus": {
            "status": "OUTBOUND_CREATED",
            "description": "string",
            "updateTime": "2017-11-21T00:00:00+03:00"
        },
        "availableActions": [
            "CONFIRM"
        ]
    }
}

Name

Description

result

Type: ShipmentDTO

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

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ShipmentDTO

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

Name	Description
availableActions*	Type: ShipmentActionType[] Доступные действия над отгрузкой. Действия с отгрузкой: `CONFIRM` — подтвердить отгрузку. `DOWNLOAD_ACT` — скачать акт приема-передачи отгрузки. `DOWNLOAD_INBOUND_ACT` — скачать список принятых заказов. `DOWNLOAD_DISCREPANCY_ACT` — скачать акт расхождений. `CHANGE_PALLETS_COUNT` — указать количество палет. Enum: `CONFIRM`, `DOWNLOAD_ACT`, `DOWNLOAD_INBOUND_ACT`, `DOWNLOAD_DISCREPANCY_ACT`, `CHANGE_PALLETS_COUNT` Unique items
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
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`
signature*	Type: SignatureDTO Информация о подписи акта приема-передачи.
currentStatus	Type: ShipmentStatusChangeDTO Статус отгрузки.
deliveryService	Type: DeliveryServiceDTO Служба доставки.
externalId	Type: string Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра `id`.
palletsCount	Type: PalletsCountDTO Данные о палетах в отгрузке.
shipmentType	Type: ShipmentType Способ отгрузки заказов. Enum: `IMPORT`, `WITHDRAW`
warehouse	Type: PartnerShipmentWarehouseDTO Данные о складе отправления.
warehouseTo	Type: PartnerShipmentWarehouseDTO Данные о складе назначения.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

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

ShipmentActionType

Действия с отгрузкой:

CONFIRM — подтвердить отгрузку.
DOWNLOAD_ACT — скачать акт приема-передачи отгрузки.
DOWNLOAD_INBOUND_ACT — скачать список принятых заказов.
DOWNLOAD_DISCREPANCY_ACT — скачать акт расхождений.
CHANGE_PALLETS_COUNT — указать количество палет.

Type	Description
ShipmentActionType	Enum: `CONFIRM`, `DOWNLOAD_ACT`, `DOWNLOAD_INBOUND_ACT`, `DOWNLOAD_DISCREPANCY_ACT`, `CHANGE_PALLETS_COUNT`

SignatureDTO

Информация о подписи акта приема-передачи.

Name

Description

signed*

Type: boolean

Подписан ли акт приема-передачи.

ShipmentStatusChangeDTO

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

Name	Description
description	Type: string Описание статуса отгрузки.
status	Type: ShipmentStatusType Статус отгрузки. Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
updateTime	Type: string<date-time> Время последнего изменения статуса отгрузки. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`

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 Наименование склада отправления.

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`

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

Перенос заказов в следующую отгрузку

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