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

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

POST /v1/order/fbs/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_id array
Идентификаторы складов маркетплейса для сдачи груза.
cursor string
Курсор для постраничного чтения.
limit integer
Размер страницы.

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

200 A successful response.
application/json
object
orders array
Список заказов на текущей странице.
Показать Скрыть
merchant_order_id string
Идентификатор заказа в системе продавца.
client_order_id string
Идентификатор заказа клиента. Может объединять несколько заказов продавца.
merchant_location_id string
Идентификатор склада сборки Продавца.
market_location_id string
Идентификатор склада маркетплейса для сдачи груза.
shipment_date string
Дата отгрузки, назначаемая витриной (RFC3339).
status string
Текущий статус заказа.
values
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: доставка в пункт выдачи.
values
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
Цены товара по типам.
Показать Скрыть
price_type string
Тип цены.
values
CUSTOMER_PRICECUSTOMER_FINAL_PRICEMERCHANT_PRICEMERCHANT_FINAL_PRICE
value integer
Значение цены, умноженное на 100.
currency_code string
Валюта.
values
RUBBYNKZTEURUSDCNY
requirements object
Требования к товару для передачи экземпляров и смены статуса.
Показать Скрыть
requires_change_country boolean
Требуется изменить страну-изготовитель.
requires_gtd boolean
Требуется передать номер ГТД.
requires_country boolean
Требуется передать страну-изготовителя.
requires_mandatory_mark boolean
Требуется маркировка «Честный знак».
requires_jw_uin boolean
Требуется УИН ювелирного изделия.
requires_rnpt boolean
Требуется РНПТ.
requires_weight boolean
Требуется передать вес.
requires_imei boolean
Требуется передать IMEI.
exemplars array
Экземпляры товара (маркировка, ГТД и т.д.); задаются через POST /v1/order/fbs/exemplar/set.
Показать Скрыть
exemplar_id string
Идентификатор экземпляра.
gtd string
Номер грузовой таможенной декларации.
rnpt string
Регистрационный номер партии товара.
weight number
Фактический вес экземпляра.
marks array
Коды маркировки экземпляра.
Показать Скрыть
mark string
Значение кода маркировки.
mark_type string
Тип маркировки: mandatory_mark, jw_uin, imei.
status_history array
История переходов статусов заказа.
Показать Скрыть
status string
Статус, в который был переведен заказ.
values
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED
changed_by string
Инициатор изменения статуса.
values
MERCHANTMARKETCLIENT
changed_at string
Время изменения статуса (RFC3339).
comment string
Комментарий к изменению.
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/list 

              1
              curl https://api.omninet.ru/v1/order/fbs/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_id": [
            
              15
                    "string"
            
              16
                  ]
            
              17
                },
            
              18
                "cursor": "string",
            
              19
                "limit": 0
            
              20
              }'
            
{
  "orders": [
    {
      "merchant_order_id": "string",
      "client_order_id": "string",
      "merchant_location_id": "string",
      "market_location_id": "string",
      "shipment_date": "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"
        }
      ],
      "requirements": {
        "requires_change_country": true,
        "requires_gtd": true,
        "requires_country": true,
        "requires_mandatory_mark": true,
        "requires_jw_uin": true,
        "requires_rnpt": true,
        "requires_weight": true,
        "requires_imei": true
      },
      "exemplars": [
        {
          "exemplar_id": "string",
          "gtd": "string",
          "rnpt": "string",
          "weight": 0,
          "marks": [
            {
              "mark": "string",
              "mark_type": "string"
            }
          ]
        }
      ],
      "status_history": [
        {
          "status": "string",
          "changed_by": "string",
          "changed_at": "string",
          "comment": "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": {}
}

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