Получение полной карточки отгрузки: реквизиты, состав, пропуск, интервал сдачи и грузоместа (packages)

POST /v1/shipment/get

POST/v1/shipment/get

Тело запроса

shipment_id
string
required
ID отгрузки.

Успешный ответ

200A successful response.
application/json
object
shipment_id
string
ID отгрузки.
market_location_id
string
ID склада.
shipment_date
string
Дата отгрузки в формате YYYY-MM-DD.
status
string
Статус отгрузки.
Допустимые значения
DRAFTCONFIRMEDACCEPTED_AT_GATECOMPLETEDCANCELLED
created_at
string
Время создания (RFC3339).
updated_at
string
Время последнего изменения (RFC3339).
timeslot
object
Назначенный интервал сдачи.
Показать свойства
id
string
Идентификатор интервала.
start_time
string
Начало интервала (RFC3339).
end_time
string
Конец интервала (RFC3339).
pass
object
Данные пропуска на склад.
Показать свойства
driver_name
string
ФИО водителя.
driver_phone
string
Телефон водителя.
vehicle_model
string
Модель транспортного средства.
vehicle_plate
string
Государственный номер транспортного средства.
planned_qty_items
integer
Заявленное суммарное количество товарных единиц.
accepted_qty_items
integer
Фактически принятое количество товарных единиц.
planned_qty_packages
integer
Заявленное количество грузомест.
accepted_qty_packages
integer
Фактически принятое количество грузомест.
items
array
Состав отгрузки.
shipmentFboItem
Показать свойства
shipmentFboItem
offer_id
string
Артикул товара в системе продавца.
product_id
string
Идентификатор товара на маркетплейсе.
barcode
string
Штрихкод товара.
ext_barcode
string
Внешний штрихкод / номер маркировки от МП.
quantity
integer
Количество единиц товара.
packages
array
Грузоместа отгрузки.
shipmentFboPackage
Показать свойства
shipmentFboPackage
package_id
string
Идентификатор грузоместа.
package_number
integer
Порядковый номер грузоместа.
type
string
Тип грузоместа.
Допустимые значения
BOXPALLET
items
array
Товары в грузоместе.
shipmentFboPackageItem
Показать свойства
shipmentFboPackageItem
offer_id
string
Артикул товара в системе продавца.
product_id
string
Идентификатор товара на маркетплейсе.
barcode
string
Штрихкод товара.
ext_barcode
string
Внешний штрихкод / номер маркировки от МП.
quantity
integer
Количество единиц товара.
accepted_quantity
integer
Количество принятых единиц в грузоместе (опционально).

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
404Отгрузка не найдена по shipment_id
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string
сообщение
details
object
POST/v1/shipment/get
1curl https://api.omninet.ru/v1/shipment/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "shipment_id": "string"6}'
{
  "shipment_id": "string",
  "market_location_id": "string",
  "shipment_date": "string",
  "status": "string",
  "created_at": "string",
  "updated_at": "string",
  "timeslot": {
    "id": "string",
    "start_time": "string",
    "end_time": "string"
  },
  "pass": {
    "driver_name": "string",
    "driver_phone": "string",
    "vehicle_model": "string",
    "vehicle_plate": "string"
  },
  "planned_qty_items": 0,
  "accepted_qty_items": 0,
  "planned_qty_packages": 0,
  "accepted_qty_packages": 0,
  "items": [
    {
      "offer_id": "string",
      "product_id": "string",
      "barcode": "string",
      "ext_barcode": "string",
      "quantity": 0
    }
  ],
  "packages": [
    {
      "package_id": "string",
      "package_number": 0,
      "type": "string",
      "items": [
        {
          "offer_id": "string",
          "product_id": "string",
          "barcode": "string",
          "ext_barcode": "string",
          "quantity": 0,
          "accepted_quantity": 0
        }
      ]
    }
  ]
}

A successful response.