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

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

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

shipmentId

Type: integer

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

Min value: 1

Query parameters

Name

Description

cancelledOrders

Type: boolean

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

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

Default: true

Responses

200 OK

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

Body

application/json
{
  "status": "OK",
  "result": {
    "id": 1,
    "planIntervalFrom": "2017-11-21T00:00:00+03:00",
    "planIntervalTo": "2017-11-21T00:00:00+03:00",
    "shipmentType": "IMPORT",
    "warehouse": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "warehouseTo": null,
    "externalId": "example",
    "deliveryService": {
      "id": 0,
      "name": "example"
    },
    "palletsCount": {
      "planned": 0,
      "fact": 0
    },
    "orderIds": [
      1
    ],
    "draftCount": 0,
    "plannedCount": 0,
    "factCount": 0,
    "signature": {
      "signed": true
    },
    "currentStatus": {
      "status": "OUTBOUND_CREATED",
      "description": "example",
      "updateTime": "2017-11-21T00:00:00+03:00"
    },
    "availableActions": [
      "CONFIRM"
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: ShipmentDTO

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

    Example
    {
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  },
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}
    Example
    {
  "result": {
    "id": 1,
    "planIntervalFrom": "2017-11-21T00:00:00+03:00",
    "planIntervalTo": "2017-11-21T00:00:00+03:00",
    "shipmentType": "IMPORT",
    "warehouse": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "warehouseTo": null,
    "externalId": "example",
    "deliveryService": {
      "id": 0,
      "name": "example"
    },
    "palletsCount": {
      "planned": 0,
      "fact": 0
    },
    "orderIds": [
      1
    ],
    "draftCount": 0,
    "plannedCount": 0,
    "factCount": 0,
    "signature": {
      "signed": true
    },
    "currentStatus": {
      "status": "OUTBOUND_CREATED",
      "description": "example",
      "updateTime": "2017-11-21T00:00:00+03:00"
    },
    "availableActions": [
      "CONFIRM"
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ShipmentType

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

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

Type: string

Enum: IMPORT, WITHDRAW

PartnerShipmentWarehouseDTO

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

Name

Description

id

Type: integer

Идентификатор склада отправления.

Min value: 1

address

Type: string

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

Example: example

name

Type: string

Наименование склада отправления.

Example: example
Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}

DeliveryServiceDTO

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

Name

Description

id

Type: integer

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

name

Type: string

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

Example: example
Example
{
  "id": 0,
  "name": "example"
}

PalletsCountDTO

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

Name

Description

fact

Type: integer

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

Min value: 0

planned

Type: integer

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

Min value: 0
Example
{
  "planned": 0,
  "fact": 0
}

SignatureDTO

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

Name

Description

signed

Type: boolean

Подписан ли акт приема-передачи.
Example
{
  "signed": true
}

BaseShipmentDTO

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

Name

Description

draftCount

Type: integer

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

Min value: 0

factCount

Type: integer

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

Min value: 0

id

Type: integer

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

Min value: 1

orderIds

Type: integer[]

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

Unique items: true

Example
[
  1
]

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

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

Min value: 0

signature

Type: SignatureDTO

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

Example
{
  "signed": true
}

deliveryService

Type: DeliveryServiceDTO

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

Example
{
  "id": 0,
  "name": "example"
}

externalId

Type: string

Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра id.

Example: example

palletsCount

Type: PalletsCountDTO

Данные о палетах в отгрузке.

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

Example
{
  "planned": 0,
  "fact": 0
}

shipmentType

Type: ShipmentType

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

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

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

Enum: IMPORT, WITHDRAW

warehouse

Type: PartnerShipmentWarehouseDTO

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

Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}

warehouseTo

Type: PartnerShipmentWarehouseDTO

Данные о складе назначения.

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

Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}
Example
{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  }
}

ShipmentStatusType

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

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

Type: string

Enum: OUTBOUND_CREATED, OUTBOUND_READY_FOR_CONFIRMATION, OUTBOUND_CONFIRMED, OUTBOUND_SIGNED, FINISHED, ACCEPTED, ACCEPTED_WITH_DISCREPANCIES, ERROR

ShipmentStatusChangeDTO

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

Name

Description

description

Type: string

Описание статуса отгрузки.

Example: example

status

Type: ShipmentStatusType

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

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

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

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
Example
{
  "status": "OUTBOUND_CREATED",
  "description": "example",
  "updateTime": "2017-11-21T00:00:00+03:00"
}

ShipmentActionType

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

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

Type: string

Enum: CONFIRM, DOWNLOAD_ACT, DOWNLOAD_INBOUND_ACT, DOWNLOAD_DISCREPANCY_ACT, DOWNLOAD_TRANSPORTATION_WAYBILL, CHANGE_PALLETS_COUNT

ExtensionShipmentDTO

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

Name

Description

availableActions

Type: ShipmentActionType[]

Доступные действия над отгрузкой.

Unique items: true

Example
[
  "CONFIRM"
]

currentStatus

Type: ShipmentStatusChangeDTO

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

Example
{
  "status": "OUTBOUND_CREATED",
  "description": "example",
  "updateTime": "2017-11-21T00:00:00+03:00"
}
Example
{
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}

ShipmentDTO

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

Type: object

All of 2 types

  • Type: BaseShipmentDTO

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

    Example
    {
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  }
}

  • Type: ExtensionShipmentDTO

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

    Example
    {
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}
Example
{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  },
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Предыдущая
Информация о документах
Следующая
Информация о нескольких отгрузках