Перейти к содержимому
Omninet

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

POST /v1/shipment/create

1 отгрузка = 1 паллета.

В отгрузку добавляются заказы в статусе READY_TO_SHIP.

Тело запроса

Заголовок раздела «Тело запроса»
market_location_id string
Идентификатор склада маркетплейса для отгрузки.
shipment_date string
Дата отгрузки в формате (YYYY-MM-DD).
merchant_order_id array
Идентификаторы заказов для включения в отгрузку.

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

200 A successful response.
application/json
object
shipment_id string
Идентификатор созданной отгрузки.
status string
Текущий статус отгрузки. Отгрузка создаётся в статусе DRAFT.
values
DRAFTREADYIN_TRANSITACCEPTEDCANCELLEDCLOSED
file_url string
URL на PDF с номером отгрузки для приёмки на складе (опционально).
shipment array
Результаты добавления заказов в отгрузку.
Показать Скрыть
merchant_order_id string
Идентификатор заказа продавца.
status string
Статус добавления.
values
ADDEDERROR
error object
Причина ошибки добавления (для статуса ADDED возвращается пустым объектом).
Показать Скрыть
code string
Код ошибки.
message string
Сообщение об ошибке.

Ошибки

400 Некорректный запрос
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
401 Ошибка авторизации
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
429 Превышен лимит запросов
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
500 Внутренняя ошибка сервера
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
POST /v1/shipment/create 

              1
              curl 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
                "merchant_order_id": [
            
              8
                  "string"
            
              9
                ]
            
              10
              }'
            
{
  "shipment_id": "string",
  "status": "DRAFT",
  "file_url": "string",
  "shipment": [
    {
      "merchant_order_id": "string",
      "status": "string",
      "error": {
        "code": "string",
        "message": "string"
      }
    }
  ]
}

A successful response.

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Некорректный запрос

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Ошибка авторизации

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Превышен лимит запросов

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

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