Создание отгрузки

POST /v1/shipment/create

POST/v1/shipment/create

Создаёт отгрузку в DRAFT. Заказы — READY_TO_SHIP. Без packages — пустая отгрузка без грузомест. Атомарно: при ошибке отгрузка не создаётся.

Тело запроса

market_location_id
string
required
Идентификатор склада маркетплейса для отгрузки.
shipment_date
string
required
Дата отгрузки в формате (YYYY-MM-DD).
packages
array
Грузоместа отгрузки (опционально). Если не передан — создаётся пустая отгрузка без грузомест.
ordersFbsShipmentCreatePackageItem
Показать свойства
ordersFbsShipmentCreatePackageItem
package_id
string
Идентификатор грузоместа (опционально).
package_number
integer
required
Порядковый номер грузоместа.
type
string
required
Тип грузоместа.
Допустимые значения
BOXPALLET
merchant_order_ids
array
required
Идентификаторы заказов в грузоместе.
idempotency_key
string
required
Ключ идемпотентности запроса создания отгрузки.

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

200A successful response.
application/json
object
shipment_id
string
required
Идентификатор созданной отгрузки.
packages
array
required
Созданные грузоместа. Пустой массив, если отгрузка создана без packages в запросе.
ordersFbsShipmentCreateResponsePackageItem
Показать свойства
ordersFbsShipmentCreateResponsePackageItem
package_id
string
required
Идентификатор грузоместа.
package_number
integer
required
Порядковый номер грузоместа.
type
string
required
Тип грузоместа.
Допустимые значения
BOXPALLET
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/create
1curl https://api.omninet.ru/v1/shipment/create \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "market_location_id": "string",6  "shipment_date": "string",7  "packages": [8    {9      "package_id": "string",10      "package_number": 0,11      "type": "string",12      "merchant_order_ids": [13        "string"14      ]15    }16  ],17  "idempotency_key": "string"18}'
{
  "shipment_id": "string",
  "packages": [
    {
      "package_id": "string",
      "package_number": 0,
      "type": "string",
      "merchant_order_ids": [
        "string"
      ]
    }
  ]
}

A successful response.