Перейти к содержаниюСправка

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия		Предыдущая версия
hc:api:orders [20.10.2026 14:52] – внешнее изменениеhc:api:orders [05.11.2026 12:19] (текущий) – внешнее изменение
Строка 60: Строка 60:
 | **id** | Число. Ид **клиента**: вернутся заказы этого клиента. Если не указан вместе с ''external_id'', возвращаются заказы всех клиентов | | **id** | Число. Ид **клиента**: вернутся заказы этого клиента. Если не указан вместе с ''external_id'', возвращаются заказы всех клиентов |
 | **external_id** | Строка. Код клиента во внешней системе. Работает так же, как ''id'' | | **external_id** | Строка. Код клиента во внешней системе. Работает так же, как ''id'' |
-| **warehouse_id** | Число. Ид точки продаж: вернутся заказы, которые выдаются из этой точки (поле ''pickup_from_warehouse_id'' заказа) |+| **warehouse_id** | Число. Ид точки продаж: вернутся заказы, которые выдаются из этой точки |
 | **ext_warehouse_id** | Строка. Код точки продаж во внешней системе. Используется, если не указан ''warehouse_id''. Если точки с таким кодом нет, список заказов пустой | | **ext_warehouse_id** | Строка. Код точки продаж во внешней системе. Используется, если не указан ''warehouse_id''. Если точки с таким кодом нет, список заказов пустой |
 | **datefrom** | Дата ''ГГГГММДД''. Заказы, созданные с этой даты. Снимает ограничение ''days'' | | **datefrom** | Дата ''ГГГГММДД''. Заказы, созданные с этой даты. Снимает ограничение ''days'' |
Строка 66: Строка 66:
 | **datechangefrom** | Дата ''ГГГГММДД''. Заказы, изменённые с этой даты | | **datechangefrom** | Дата ''ГГГГММДД''. Заказы, изменённые с этой даты |
 | **days** | Число. Глубина поиска в днях по дате создания. По умолчанию **30**. Не применяется, если указан ''datefrom'' | | **days** | Число. Глубина поиска в днях по дате создания. По умолчанию **30**. Не применяется, если указан ''datefrom'' |
 +| **extra_data** | ''1'' или ''true'' — добавить к заказам данные модулей, например номер отправления и штрихкоды Озона. См. [[#Данные модулей (extra_data)]]. По умолчанию выключен |
 | **format** | ''json'' (по умолчанию) или ''xml'' | | **format** | ''json'' (по умолчанию) или ''xml'' |
 </WRAP> </WRAP>
Строка 84: Строка 85:
 | **id** | Число. Ид заказа | | **id** | Число. Ид заказа |
 | **external_id** | Строка. Код заказа во внешней системе (поле ''guid''). Используется, если не указан ''id'' | | **external_id** | Строка. Код заказа во внешней системе (поле ''guid''). Используется, если не указан ''id'' |
 +| **extra_data** | ''1'' или ''true'' — добавить к заказу данные модулей. См. [[#Данные модулей (extra_data)]] |
 </WRAP> </WRAP>
  
Строка 138: Строка 140:
 | **amount** | Строка. Сумма по строке с учётом скидки | | **amount** | Строка. Сумма по строке с учётом скидки |
 </WRAP> </WRAP>
 +
 +==== Данные модулей (extra_data) ====
 +
 +С параметром ''extra_data=1'' в заказ добавляются данные подключённых модулей. Без параметра (или с ''extra_data=0'') ответ остаётся прежним. Параметр работает в методах ''orders'' и ''get_order'', а также в ответах ''update_order'', ''add_orders_item'', ''update_order_item'' и ''delete_orders_item''.
 +
 +**Блок ''ozon''** есть только у заказов, пришедших с Озона (см. [[hc:online:ozon|Озон]]). У остальных заказов блока нет. Поля и их значения передаются так, как их отдаёт Озон, без изменений.
 +
 +<WRAP props>
 +| **posting_number** | Строка. Номер отправления Озона |
 +| **tracking_number** | Строка. Трек-номер сторонней службы доставки (агрегатора). При доставке Озоном — пустая строка |
 +| **scanit** | Строка. Номер с этикетки отправления, например ''ii50247192380''. Озон присваивает его, когда отправление собрано |
 +| **barcodes** | Объект. Штрихкоды с этикетки отправления: ''upper_barcode'' — верхний, ''lower_barcode'' — нижний |
 +</WRAP>
 +
 +Данные берутся из отправления, сохранённого при последнем обмене с Озоном, — запрос к Озону метод не делает. Если у отправления ещё нет какого-то поля, оно приходит как ''null'' (в XML — пустой элемент).
 +
 +<code>
 +GET https://[компания].myvirtualpos.ru/api/orders/get_order?apikey=MySecret&id=24240&extra_data=1
 +</code>
 +
 +<code json>
 +{
 +  "success": 1,
 +  "count": 1,
 +  "type": "orders",
 +  "orders": [
 +    {
 +      "order": {
 +        "id": 24240,
 +        "state": "PREPARING",
 +        "state_name": "Комплектуется",
 +        "items": [ … ],
 +        "ozon": {
 +          "posting_number": "12345678-0001-1",
 +          "tracking_number": "",
 +          "scanit": "ii50247192380",
 +          "barcodes": {
 +            "upper_barcode": "500100000000001",
 +            "lower_barcode": "500100000000001"
 +          }
 +        }
 +      }
 +    }
 +  ]
 +}
 +</code>
 +
 +В XML блок приходит элементом ''<ozon>'' с теми же полями.
  
 ==== Статусы заказа ==== ==== Статусы заказа ====
Строка 353: Строка 403:
 | Заказ по ид | ''/api/orders/get_order?apikey=MySecret&id=24238'' | | Заказ по ид | ''/api/orders/get_order?apikey=MySecret&id=24238'' |
 | Заказ по коду | ''/api/orders/get_order?apikey=MySecret&external_id=WEB-1001'' | | Заказ по коду | ''/api/orders/get_order?apikey=MySecret&external_id=WEB-1001'' |
 +| Заказы за 7 дней с номерами отправлений и штрихкодами Озона | ''/api/orders?apikey=MySecret&days=7&extra_data=1'' |
  
 ===== Ошибки ===== ===== Ошибки =====
Строка 385: Строка 436:
   * [[hc:api:customer|Customer. Клиенты]] Клиенты, для которых создаются заказы   * [[hc:api:customer|Customer. Клиенты]] Клиенты, для которых создаются заказы
   * [[hc:api:item|Item. Номенклатура]] Товары в заказах   * [[hc:api:item|Item. Номенклатура]] Товары в заказах
 +  * [[hc:online:ozon|Озон]] Заказы с Озона и обмен отправлениями
 </WRAP> </WRAP>