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

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

POST /v1/shipment/get

Тело запроса

Заголовок раздела «Тело запроса»
shipment_id string
Идентификатор отгрузки.

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

200 A successful response.
application/json
object
shipment object
Полная карточка отгрузки.
Показать Скрыть
shipment object
Основные атрибуты отгрузки.
Показать Скрыть
shipment_id string
Идентификатор отгрузки.
market_location_id string
Идентификатор склада маркетплейса для отгрузки.
shipment_date string
Дата отгрузки в формате (YYYY-MM-DD).
status string
Текущий статус отгрузки.
values
DRAFTREADYIN_TRANSITACCEPTEDCANCELLEDCLOSED
orders_count integer
Количество заказов в отгрузке.
created_at string
Время создания отгрузки (RFC3339).
updated_at string
Время последнего обновления отгрузки (RFC3339).
orders array
Заказы, входящие в отгрузку.
Показать Скрыть
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента. Может объединять несколько заказов продавца.
status string
Статус заказа внутри отгрузки.
values
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED

Ошибки

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/get 

              1
              curl https://api.omninet.ru/v1/shipment/get \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "shipment_id": "string"
            
              6
              }'
            
{
  "shipment": {
    "shipment": {
      "shipment_id": "string",
      "market_location_id": "string",
      "shipment_date": "string",
      "status": "DRAFT",
      "orders_count": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "orders": [
      {
        "merchant_order_id": "string",
        "client_order_id": "string",
        "status": "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": {}
}

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