Список отгрузок с фильтрацией

POST /v1/shipment/list

POST/v1/shipment/list

Тело запроса

filter
object
Параметры фильтрации списка отгрузок.
Показать свойства
shipment_ids
array
Фильтр по идентификаторам отгрузок.
status
array
Фильтр по статусам отгрузки.
Жизненный цикл отгрузки: DRAFT → CONFIRMED → ACCEPTED_AT_GATE → COMPLETED; отмена из DRAFT/CONFIRMED → CANCELLED.
market_location_ids
array
Фильтр по складам.
shipment_date
string
Фильтр по точной дате отгрузки (YYYY-MM-DD).
shipment_date_from
string
Начало периода по дате отгрузки (YYYY-MM-DD).
shipment_date_to
string
Конец периода по дате отгрузки (YYYY-MM-DD).
updated_since
string
Нижняя граница времени обновления (RFC3339).
updated_to
string
Верхняя граница времени обновления (RFC3339).
cursor
string
Курсор постраничной выборки.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.
application/json
object
shipments
array
Список отгрузок.
shipmentFboListItem
Показать свойства
shipmentFboListItem
shipment_id
string
Идентификатор отгрузки.
market_location_id
string
Идентификатор склада.
shipment_date
string
Дата отгрузки в формате YYYY-MM-DD.
status
string
Статус отгрузки.
Допустимые значения
DRAFTCONFIRMEDACCEPTED_AT_GATECOMPLETEDCANCELLED
timeslot
object
Назначенный интервал сдачи.
Показать свойства
id
string
Идентификатор интервала.
start_time
string
Начало интервала (RFC3339).
end_time
string
Конец интервала (RFC3339).
next_cursor
string
Курсор следующей страницы.

Ошибки

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
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
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
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
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
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
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
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
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
Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
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    "shipment_ids": [7      "string"8    ],9    "status": [10      "string"11    ],12    "market_location_ids": [13      "string"14    ],15    "shipment_date": "string",16    "shipment_date_from": "string",17    "shipment_date_to": "string",18    "updated_since": "string",19    "updated_to": "string"20  },21  "cursor": "string",22  "limit": 023}'
{
  "shipments": [
    {
      "shipment_id": "string",
      "market_location_id": "string",
      "shipment_date": "string",
      "status": "string",
      "timeslot": {
        "id": "string",
        "start_time": "string",
        "end_time": "string"
      }
    }
  ],
  "next_cursor": "string"
}

A successful response.