Детальная карточка отгрузки

POST /v1/shipment/get

POST/v1/shipment/get

Любой статус отгрузки.

Тело запроса

shipment_id

string

required

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

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

200A successful response.

application/json

object

shipment_id

string

required

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

market_location_id

string

required

Идентификатор склада маркетплейса для отгрузки.

shipment_date

string

required

Дата отгрузки в формате (YYYY-MM-DD).

status

string

required

Статусы отгрузки FBS. DRAFT — черновик. READY — готова к сдаче (MERCHANT). IN_TRANSIT — в пути (MERCHANT после READY и pass/update). CANCELLED — отменена (только shipment/cancel, до IN_TRANSIT). ACCEPTED_AT_GATE — принята на воротах (MARKET). PARTIALLY_ACCEPTED — принято частично: 0 < accepted_qty_packages < planned_qty_packages (MARKET). ACCEPTED — принято полностью: accepted_qty_packages = planned_qty_packages (MARKET). Пока accepted_qty_packages = 0, отгрузка не считается принятой.

Допустимые значения

DRAFTREADYIN_TRANSITACCEPTED_AT_GATEPARTIALLY_ACCEPTEDACCEPTEDCANCELLED

created_at

string

required

Время создания отгрузки (RFC3339).

updated_at

string

required

Время последнего обновления отгрузки (RFC3339).

planned_qty_packages

integer

required

Плановое количество грузовых мест.

accepted_qty_packages

integer

required

Принятое количество грузовых мест.

packages

array

required

Грузоместа отгрузки с составом заказов и статусами приёмки.

ordersFbsShipmentPackageResponseItem

Показать свойства

ordersFbsShipmentPackageResponseItem

package_id

string

required

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

package_number

integer

required

Порядковый номер грузоместа.

type

string

required

BOX — короб; PALLET — паллета.

Допустимые значения

BOXPALLET

status

string

required

PLANNED — запланировано; ACCEPTED — принято; REJECTED — не принято.

Допустимые значения

PLANNEDACCEPTEDREJECTED

merchant_order_ids

array

required

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

Ошибки

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

код ошибки

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

код ошибки

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

код ошибки

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

код ошибки

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

код ошибки

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": "DRAFT",
  "created_at": "string",
  "updated_at": "string",
  "planned_qty_packages": 0,
  "accepted_qty_packages": 0,
  "packages": [
    {
      "package_id": "string",
      "package_number": 0,
      "type": "string",
      "status": "string",
      "merchant_order_ids": [
        "string"
      ]
    }
  ]
}

A successful response.