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

Получение списка заказов

POST /v1/order/dbs/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Фильтр.
Показать Скрыть
status array
Фильтр по статусам заказа (опционально).
Статусы доставки заказа.

- NEW: Новый.
- CONFIRMED: Подтверждён.
- PACKED: Упакован.
- DELIVERING: Доставляется.
- READY_FOR_PICKUP: Готов к выдаче на ПВЗ.
- DELIVERED: Доставлен.
- CANCELLED: Отменён.
merchant_order_id array
Фильтр по идентификаторам заказов продавца (опционально).
since string
Начало периода по дате создания. Формат: date-time (RFC3339, опционально).
to string
Конец периода по дате создания. Формат: date-time (RFC3339, опционально).
cursor string
Курсор начала отсчёта.
limit integer
Лимит записей.

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

200 A successful response.
application/json
object
orders array
Элементы списка.
Draft-вариант DBS one item / one order: в заказе один товар, поэтому поля товара возвращаются на верхнем уровне элемента orders[] (без вложенного объекта product и без массива products).

Идентификаторы offer_id и product_id используются с приоритезацией.

Если заполнены оба идентификатора, то используется только offer_id.
Показать Скрыть
merchant_order_id string required
Идентификатор заказа продавца.
client_order_id string required
Идентификатор заказа клиента.
location_id string required
ID склада продавца, на который поступило сборочное задание.
status string required
Статус заказа (доставки).
values
NEWCONFIRMEDPACKEDDELIVERINGREADY_FOR_PICKUPDELIVEREDCANCELLED
actions array
Разрешённые действия по заказу для установленного статуса.
Разрешённое действие по заказу для установленного статуса.
Показать Скрыть
type string required
Тип действия.
values
cancel
enabled boolean required
Доступность действия.
handover_code string
Код вручения заказа.
customer object required
Данные о покупателе.
Показать Скрыть
customer_id string
Идентификатор покупателя.
name string
Имя покупателя.
phone string
Контактный телефон покупателя.
delivery object required
Параметры доставки или выдачи в ПВЗ.
Показать Скрыть
delivery_type string required
Тип доставки или выдачи.

- COURIER: доставка курьером — обязателен address_tail.
- PICKUP_POINT: доставка в пункт выдачи.
- CLICK_AND_COLLECT: самовывоз (Click & Collect).
values
COURIERPICKUP_POINTCLICK_AND_COLLECT
address_tail string
Адрес в текстовом формате. Обязателен при delivery_type = COURIER.
comment string
Комментарий к доставке или адресу.
latitude number
Широта.
provider_location_id string
Идентификатор локации у провайдера доставки.
longitude number
Долгота.
product_id string required
Идентификатор товара в системе маркетплейса.
offer_id string required
Идентификатор товара в системе продавца — артикул.
product_name string required
Название товара.
prices array required
Цены товара.
Показать Скрыть
price_type string
Тип цены.
values
CUSTOMER_PRICECUSTOMER_FINAL_PRICEMERCHANT_PRICEMERCHANT_FINAL_PRICE
value integer
Значение цены, умноженное на 100.
currency_code string
Валюта.
values
RUBBYNKZTEURUSDCNY
vat string
НДС.
values
VAT_0VAT_5VAT_7VAT_22NO_VAT
exemplar object
Информация об экземпляре товара.
Показать Скрыть
exemplar_id string
Идентификатор экземпляра.
gtd string
Номер грузовой таможенной декларации (ГТД).
marks array
Контрольные знаки и другие маркировки.
Показать Скрыть
mark string
Значение кода маркировки.
mark_type string
Тип маркировки: mandatory_mark, jw_uin, imei.
rnpt string
Регистрационный номер партии товара (РНПТ).
weight number
Фактический вес экземпляра.
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.
prr_option string
Код услуги ПРР: lift, stairs, none, delivery_default.
status_history array
История статусов заказа.
Показать Скрыть
changed_by string
Инициатор изменения.
values
MERCHANTCLIENTMARKET
changed_at string
Время изменения (date-time, RFC3339).
status string
Статус заказа (доставки).
values
NEWCONFIRMEDPACKEDDELIVERINGREADY_FOR_PICKUPDELIVEREDCANCELLED
comment string
Описание причины изменения.
delivery_date_history array
История изменения даты доставки.
Показать Скрыть
changed_by string
Инициатор.
values
MERCHANTCLIENTMARKET
changed_at string
Когда менял (date-time, RFC3339).
delivery_date_begin string
Дата и время начала доставки (date-time, RFC3339).
delivery_date_end string
Ожидаемая дата доставки (date-time, RFC3339).
comment string
Описание причины изменения.
delivery_date object required
Слот доставки: дата и время начала и окончания.
Показать Скрыть
delivery_date_begin string
Дата и время начала доставки (date-time, RFC3339).
delivery_date_end string
Ожидаемая дата доставки (date-time, RFC3339).
created_at string required
Дата и время создания заказа (date-time, 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/dbs/list 

              1
              curl https://api.omninet.ru/v1/order/dbs/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "status": [
            
              7
                    "NEW"
            
              8
                  ],
            
              9
                  "merchant_order_id": [
            
              10
                    "string"
            
              11
                  ],
            
              12
                  "since": "string",
            
              13
                  "to": "string"
            
              14
                },
            
              15
                "cursor": "string",
            
              16
                "limit": 0
            
              17
              }'
            
{
  "orders": [
    {
      "merchant_order_id": "string",
      "client_order_id": "string",
      "location_id": "string",
      "status": "NEW",
      "actions": [
        {
          "type": "cancel",
          "enabled": true
        }
      ],
      "handover_code": "string",
      "customer": {
        "customer_id": "string",
        "name": "string",
        "phone": "string"
      },
      "delivery": {
        "delivery_type": "string",
        "address_tail": "string",
        "comment": "string",
        "latitude": 0,
        "provider_location_id": "string",
        "longitude": 0
      },
      "product_id": "string",
      "offer_id": "string",
      "product_name": "string",
      "prices": [
        {
          "price_type": "CUSTOMER_PRICE",
          "value": 0,
          "currency_code": "RUB",
          "vat": "string"
        }
      ],
      "exemplar": {
        "exemplar_id": "string",
        "gtd": "string",
        "marks": [
          {
            "mark": "string",
            "mark_type": "string"
          }
        ],
        "rnpt": "string",
        "weight": 0
      },
      "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
      },
      "prr_option": "string",
      "status_history": [
        {
          "changed_by": "MERCHANT",
          "changed_at": "string",
          "status": "NEW",
          "comment": "string"
        }
      ],
      "delivery_date_history": [
        {
          "changed_by": "MERCHANT",
          "changed_at": "string",
          "delivery_date_begin": "string",
          "delivery_date_end": "string",
          "comment": "string"
        }
      ],
      "delivery_date": {
        "delivery_date_begin": "string",
        "delivery_date_end": "string"
      },
      "created_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": {}
}

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