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

POST /v1/order/fbs/list

POST/v1/order/fbs/list

Тело запроса

filter
object
required
Параметры фильтрации списка заказов.
Показать свойства
merchant_order_id
array
required
Список идентификаторов заказов продавца для фильтрации.
status
array
required
Набор статусов заказа для фильтра.
Статусы заказа FBS: NEW — новый; CONFIRMED — подтверждён; READY_TO_SHIP — готов к отгрузке; SHIPPED — отгружен; ACCEPTED_AT_WAREHOUSE — принят на складе приёмки; DELIVERED — доставлен; CANCELLED — отменён.
updated_since
string
required
Нижняя граница времени обновления (RFC3339).
updated_to
string
required
Верхняя граница времени обновления (RFC3339).
market_location_id
array
required
Идентификаторы складов маркетплейса для сдачи груза.
cursor
string
required
Курсор для постраничного чтения.
limit
integer
required
Размер страницы (min=1, max=300, default=100).

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

200A successful response.
application/json
object
orders
array
required
Список заказов на текущей странице.
ordersFbsOrderListItem
Показать свойства
ordersFbsOrderListItem
merchant_order_id
string
required
Идентификатор заказа в системе продавца.
client_order_id
string
required
Идентификатор заказа клиента. Может объединять несколько заказов продавца.
merchant_location_id
string
Идентификатор склада сборки Продавца (опционально).
market_location_id
string
required
Идентификатор склада маркетплейса для сдачи груза.
shipment_date
string
required
Дата отгрузки, назначаемая витриной (RFC3339).
status
string
required
Текущий статус заказа.
Допустимые значения
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED
created_at
string
required
Время создания заказа (RFC3339).
updated_at
string
required
Время последнего обновления заказа (RFC3339).
delivery
object
required
Параметры доставки или выдачи в ПВЗ.
Показать свойства
delivery_type
string
required
Тип доставки или выдачи. - COURIER: доставка курьером — обязателен address_tail внутри delivery. - PICKUP_POINT: доставка в пункт выдачи.
Допустимые значения
COURIERPICKUP_POINT
address_tail
string
required
Адрес в текстовом формате. Обязателен при delivery_type = COURIER.
comment
string
required
Комментарий к доставке или адресу.
latitude
number
required
Широта.
provider_location_id
string
required
Идентификатор локации у провайдера доставки.
longitude
number
required
Долгота.
product_id
string
required
Идентификатор товара на маркетплейсе.
offer_id
string
required
Артикул товара в системе продавца.
name
string
required
Название товара.
prices
array
required
Цены товара по типам.
ordersFbsOrderProductPrice
Показать свойства
ordersFbsOrderProductPrice
price_type
string
required
Тип цены.
Допустимые значения
CUSTOMER_PRICECUSTOMER_FINAL_PRICEMERCHANT_PRICEMERCHANT_FINAL_PRICE
value
integer
required
Значение цены, умноженное на 100.
currency_code
string
required
Валюта.
Допустимые значения
RUBBYNKZTEURUSDCNY
requirements
object
required
Требования к товару для передачи экземпляров и смены статуса.
Показать свойства
requires_change_country
boolean
required
Требуется изменить страну-изготовитель.
requires_gtd
boolean
required
Требуется передать номер ГТД.
requires_country
boolean
required
Требуется передать страну-изготовителя.
requires_mandatory_mark
boolean
required
Требуется маркировка «Честный знак».
requires_jw_uin
boolean
required
Требуется УИН ювелирного изделия.
requires_rnpt
boolean
required
Требуется РНПТ.
requires_weight
boolean
required
Требуется передать вес.
requires_imei
boolean
required
Требуется передать IMEI.
exemplars
array
required
Экземпляры товара (маркировка, ГТД и т.д.); задаются через POST /v1/order/fbs/exemplar/set.
ordersFbsOrderExemplar
Показать свойства
ordersFbsOrderExemplar
exemplar_id
integer
required
Идентификатор экземпляра.
gtd
string
required
Номер грузовой таможенной декларации.
rnpt
string
required
Регистрационный номер партии товара.
weight
number
required
Фактический вес экземпляра.
marks
array
required
Коды маркировки экземпляра.
ordersFbsOrderExemplarMark
Показать свойства
ordersFbsOrderExemplarMark
mark
string
required
Значение кода маркировки.
mark_type
string
required
Тип маркировки: mandatory_mark, jw_uin, imei.
status_history
array
required
История переходов статусов заказа.
ordersFbsStatusHistoryItem
Показать свойства
ordersFbsStatusHistoryItem
status
string
required
Статус, в который был переведен заказ.
Допустимые значения
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED
changed_by
string
required
Инициатор изменения статуса.
Допустимые значения
MERCHANTMARKETCLIENT
changed_at
string
required
Время изменения статуса (RFC3339).
comment
string
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/order/fbs/list
1curl 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": 020}'
{
  "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": 0,
          "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.