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

Получение обновлений статусов заказов

POST /v1/order/fbs/status/list

Тело запроса

Заголовок раздела «Тело запроса»
cursor string
Курсор страницы обновлений.
limit integer
Размер страницы.
filter object
Фильтры по обновлениям.
Показать Скрыть
merchant_order_id array
Фильтр по идентификаторам заказов продавца.
status array
Фильтр по статусам заказов.
Статусы заказа FBS: NEW — новый; CONFIRMED — подтвержден; READY_TO_SHIP — готов к отгрузке; SHIPPED — отгружен; ACCEPTED_AT_WAREHOUSE — принят на складе приемки; DELIVERED — доставлен; CANCELLED — отменен.
updated_since string
Нижняя граница времени обновления (RFC3339).

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

200 A successful response.
application/json
object
order_updates array
Список изменившихся заказов.
Показать Скрыть
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента. Может объединять несколько заказов продавца.
status string
Новый/текущий статус заказа.
values
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED
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/order/fbs/status/list 

              1
              curl https://api.omninet.ru/v1/order/fbs/status/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "cursor": "string",
            
              6
                "limit": 0,
            
              7
                "filter": {
            
              8
                  "merchant_order_id": [
            
              9
                    "string"
            
              10
                  ],
            
              11
                  "status": [
            
              12
                    "string"
            
              13
                  ],
            
              14
                  "updated_since": "string"
            
              15
                }
            
              16
              }'
            
{
  "order_updates": [
    {
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "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": {}
}

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