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

POST /v1/shipment/list

POST/v1/shipment/list

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

Тело запроса

filter
object
Параметры фильтрации отгрузок (опционально).
Показать свойства
status
array
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, отгрузка не считается принятой.
updated_since
string
required
Нижняя граница времени обновления отгрузки (RFC3339).
shipment_ids
array
required
Список идентификаторов отгрузок для фильтрации.
market_location_ids
array
required
Фильтр по идентификаторам складов маркетплейса.
shipment_date_from
string
required
Начальная дата отгрузки в формате (YYYY-MM-DD).
shipment_date_to
string
required
Конечная дата отгрузки в формате (YYYY-MM-DD).
updated_to
string
required
Верхняя граница времени обновления отгрузки (RFC3339).
cursor
string
required
Курсор постраничной выборки.
limit
integer
required
Размер страницы (min=1, max=300, default=100).

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

200A successful response.
application/json
object
shipments
array
required
Список отправлений на странице.
ordersFbsShipmentListItem
Показать свойства
ordersFbsShipmentListItem
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).
packages_count
integer
required
Количество грузомест в отгрузке.
next_cursor
string
required
Курсор следующей страницы.
total
integer
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/list
1curl https://api.omninet.ru/v1/shipment/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "status": [7      "DRAFT"8    ],9    "updated_since": "string",10    "shipment_ids": [11      "string"12    ],13    "market_location_ids": [14      "string"15    ],16    "shipment_date_from": "string",17    "shipment_date_to": "string",18    "updated_to": "string"19  },20  "cursor": "string",21  "limit": 10022}'
{
  "shipments": [
    {
      "shipment_id": "string",
      "market_location_id": "string",
      "shipment_date": "string",
      "status": "DRAFT",
      "created_at": "string",
      "updated_at": "string",
      "packages_count": 0
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.