Список заказов FBO с фильтрами и пагинацией

POST /v1/order/fbo/list

POST/v1/order/fbo/list

Тело запроса

filter

object

Фильтры списка заказов.

Показать свойства

merchant_order_id

array

Фильтр по заказам продавца.

status

array

Фильтр по статусам.

Статусы заказа FBS: NEW — новый; CONFIRMED — подтвержден; READY_TO_SHIP — готов к отгрузке; SHIPPED — отгружен; ACCEPTED_AT_WAREHOUSE — принят на складе приемки; DELIVERED — доставлен; CANCELLED — отменен.

updated_since

string

Нижняя граница обновления (RFC3339).

updated_to

string

Верхняя граница обновления (RFC3339).

market_location_ids

array

Фильтр по складам отгрузки.

cursor

string

Курсор постраничной выборки.

limit

integer

Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.

application/json

object

orders

array

Список заказов.

ordersFboOrderListItem

Показать свойства

ordersFboOrderListItem

merchant_order_id

string

Идентификатор заказа продавца.

client_order_id

string

Идентификатор заказа клиента.

market_location_id

string

Идентификатор склада маркетплейса.

status

string

Текущий статус заказа.

Допустимые значения

NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED

created_at

string

Время создания заказа (RFC3339).

updated_at

string

Время обновления заказа (RFC3339).

delivery

object

Параметры доставки.

Показать свойства

delivery_type

string

required

Тип доставки или выдачи. - COURIER: доставка курьером — обязателен address_tail внутри delivery. - PICKUP_POINT: доставка в пункт выдачи.

Допустимые значения

COURIERPICKUP_POINT

address_tail

string

Адрес в текстовом формате. Обязателен при delivery_type = COURIER.

comment

string

Комментарий к доставке или адресу.

latitude

number

Широта.

provider_location_id

string

Идентификатор локации у провайдера доставки.

longitude

number

Долгота.

product_id

string

Идентификатор товара.

offer_id

string

Артикул продавца.

name

string

Название товара.

prices

array

Цены товара.

ordersFboOrderProductPrice

Показать свойства

ordersFboOrderProductPrice

price_type

string

Тип цены.

Допустимые значения

CUSTOMER_PRICECUSTOMER_FINAL_PRICEMERCHANT_PRICEMERCHANT_FINAL_PRICE

value

integer

Значение цены, умноженное на 100.

currency_code

string

Валюта.

Допустимые значения

RUBBYNKZTEURUSDCNY

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

1curl https://api.omninet.ru/v1/order/fbo/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "merchant_order_id": [7      "string"8    ],9    "status": [10      "string"11    ],12    "updated_since": "string",13    "updated_to": "string",14    "market_location_ids": [15      "string"16    ]17  },18  "cursor": "string",19  "limit": 020}'

{
  "orders": [
    {
      "merchant_order_id": "string",
      "client_order_id": "string",
      "market_location_id": "string",
      "status": "string",
      "created_at": "string",
      "updated_at": "string",
      "delivery": {
        "delivery_type": "string",
        "address_tail": "string",
        "comment": "string",
        "latitude": 0,
        "provider_location_id": "string",
        "longitude": 0
      },
      "product_id": "string",
      "offer_id": "string",
      "name": "string",
      "prices": [
        {
          "price_type": "CUSTOMER_PRICE",
          "value": 0,
          "currency_code": "RUB"
        }
      ]
    }
  ],
  "next_cursor": "string"
}

A successful response.