Различия

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

--- hc:api:orders [26.09.2026 14:03] – создано - внешнее изменение
+++ hc:api:orders [05.11.2026 12:19] (текущий) – внешнее изменение
@@ Строка 3: / Строка 3: @@
 ====== Orders. Заказы ======
-Методы для работы с заказами покупателей: получение заказов клиента или конкретного заказа, создание заказа, изменение его данных, добавление, изменение и удаление строк, справочники типов оплаты и доставки.
+Методы для работы с заказами покупателей: получение заказов клиента, точки продаж или конкретного заказа, создание заказа, изменение его данных, добавление, изменение и удаление строк, справочники типов оплаты и доставки.
 <WRAP info>
@@ Строка 60: / Строка 60: @@
 | **id** | Число. Ид **клиента**: вернутся заказы этого клиента. Если не указан вместе с ''external_id'', возвращаются заказы всех клиентов |
 | **external_id** | Строка. Код клиента во внешней системе. Работает так же, как ''id'' |
+| **warehouse_id** | Число. Ид точки продаж: вернутся заказы, которые выдаются из этой точки |
+| **ext_warehouse_id** | Строка. Код точки продаж во внешней системе. Используется, если не указан ''warehouse_id''. Если точки с таким кодом нет, список заказов пустой |
 | **datefrom** | Дата ''ГГГГММДД''. Заказы, созданные с этой даты. Снимает ограничение ''days'' |
 | **dateto** | Дата ''ГГГГММДД''. Заказы, созданные не позднее этой даты |
 | **datechangefrom** | Дата ''ГГГГММДД''. Заказы, изменённые с этой даты |
 | **days** | Число. Глубина поиска в днях по дате создания. По умолчанию **30**. Не применяется, если указан ''datefrom'' |
+| **extra_data** | ''1'' или ''true'' — добавить к заказам данные модулей, например номер отправления и штрихкоды Озона. См. [[#Данные модулей (extra_data)]]. По умолчанию выключен |
 | **format** | ''json'' (по умолчанию) или ''xml'' |
 </WRAP>
@@ Строка 82: / Строка 85: @@
 | **id** | Число. Ид заказа |
 | **external_id** | Строка. Код заказа во внешней системе (поле ''guid''). Используется, если не указан ''id'' |
+| **extra_data** | ''1'' или ''true'' — добавить к заказу данные модулей. См. [[#Данные модулей (extra_data)]] |
 </WRAP>
@@ Строка 104: / Строка 108: @@
 | **customer_id** | Число. Ид клиента. Пусто у заказов без клиента |
 | **state** | Строка. Статус заказа, см. раздел «Статусы заказа» |
+| **state_name** | Строка. Название статуса заказа из справочника статусов, например «Готов к выдаче» |
 | **assembled** | Логическое. Заказ собран и готов к выдаче |
 | **cancelled** | Логическое. Заказ отменён |
@@ Строка 135: / Строка 140: @@
 | **amount** | Строка. Сумма по строке с учётом скидки |
 </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>'' с теми же полями.
 ==== Статусы заказа ====
@@ Строка 168: / Строка 221: @@
         "customer_id": 40823,
         "state": "NEW",
+        "state_name": "Новый",
         "assembled": false,
         "cancelled": false,
@@ Строка 217: / Строка 271: @@
       <customer_id>40823</customer_id>
       <state>NEW</state>
+      <state_name>Новый</state_name>
       <assembled/>
       <!-- остальные поля заказа -->
@@ Строка 344: / Строка 399: @@
 | Заказы клиента за 90 дней | ''/api/orders?apikey=MySecret&id=40823&days=90'' |
 | Заказы клиента по коду из внешней системы | ''/api/orders?apikey=MySecret&external_id=CRM-1001&datefrom=20260101'' |
+| Заказы точки продаж за 7 дней | ''/api/orders?apikey=MySecret&warehouse_id=6&days=7'' |
 | Заказы всех клиентов, изменённые с даты | ''/api/orders?apikey=MySecret&datechangefrom=20260925&days=3650'' |
 | Заказ по ид | ''/api/orders/get_order?apikey=MySecret&id=24238'' |
 | Заказ по коду | ''/api/orders/get_order?apikey=MySecret&external_id=WEB-1001'' |
+| Заказы за 7 дней с номерами отправлений и штрихкодами Озона | ''/api/orders?apikey=MySecret&days=7&extra_data=1'' |
 ===== Ошибки =====
@@ Строка 379: / Строка 436: @@
   * [[hc:api:customer|Customer. Клиенты]] Клиенты, для которых создаются заказы
   * [[hc:api:item|Item. Номенклатура]] Товары в заказах
+  * [[hc:online:ozon|Озон]] Заказы с Озона и обмен отправлениями
 </WRAP>