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

Список отгрузок с фильтрами

POST /v1/shipment/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Параметры фильтрации поставок.
Показать Скрыть
shipment_id array
Идентификаторы отгрузок для фильтра.
status array
Статусы отгрузок для фильтра.
Статусы отправления FBS.
updated_since string
Нижняя граница времени обновления отгрузки (RFC3339).
cursor string
Курсор постраничной выборки.
limit integer
Размер страницы.

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

200 A successful response.
application/json
object
shipments array
Список отправлений на странице.
Показать Скрыть
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).
next_cursor string
Курсор следующей страницы.
total integer
Общее количество отгрузок по фильтру.

Ошибки

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

              1
              curl https://api.omninet.ru/v1/shipment/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "shipment_id": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "status": [
            
              10
                    "DRAFT"
            
              11
                  ],
            
              12
                  "updated_since": "string"
            
              13
                },
            
              14
                "cursor": "string",
            
              15
                "limit": 0
            
              16
              }'
            
{
  "shipments": [
    {
      "shipment_id": "string",
      "market_location_id": "string",
      "shipment_date": "string",
      "status": "DRAFT",
      "orders_count": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "next_cursor": "string",
  "total": 0
}

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": {}
}

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