shopping_cartOrders. Заказы

Методы для работы с заказами покупателей: получение заказов клиента или конкретного заказа, создание заказа, изменение его данных, добавление, изменение и удаление строк, справочники типов оплаты и доставки.

GET https://[компания].myvirtualpos.ru/api/orders/get_payment_types?apikey=MySecret
GET https://[компания].myvirtualpos.ru/api/orders/get_delivery_types?apikey=MySecret

Методы возвращают только доступные к выбору типы. Ид из этих справочников указывается в payment_type_id и delivery_type_id при создании заказа.

{
  "success": 1,
  "payment_types": [
    { "type": { "id": 1, "name": "Оплата при получении" } },
    { "type": { "id": 2, "name": "Оплата онлайн" } }
  ]
}

Для типов доставки список приходит в поле delivery_types, структура такая же. Если типов нет, success равен 0, а список — null.

GET https://[компания].myvirtualpos.ru/api/orders?apikey=MySecret&id=40823&days=90

Условия объединяются по «и». Заказы возвращаются по убыванию ид: новые первыми. Если клиент не найден, метод возвращает ошибку «Клиент не найден».

GET https://[компания].myvirtualpos.ru/api/orders/get_order?apikey=MySecret&id=24237

Ответ по структуре совпадает с ответом метода orders, с одним заказом в списке. Ограничения по дате нет.

Пустые значения в JSON приходят как null, в XML — как пустой элемент.

В XML логические поля (assembled, cancelled, completed) для значения «нет» приходят пустыми элементами.

Строка заказа

Статус хранится в поле state. Набор статусов настраивается в системе; в базовой поставке:

Актуальный список — в разделе настройки статусов заказов панели управления.

{
  "success": 1,
  "count": 1,
  "type": "orders",
  "orders": [
    {
      "order": {
        "id": 24238,
        "paid": 1,
        "customer_id": 40823,
        "state": "NEW",
        "assembled": false,
        "cancelled": false,
        "completed": false,
        "shipping_address": "г. Москва, ул. Тверская, д. 3",
        "shipping_cost": "130.00",
        "pickup_receipt_id": null,
        "comment": "После шести",
        "external_id": "WEB-1001",
        "created_date": "2026-09-26 10:31:01",
        "amount": "200.00",
        "discount": 10,
        "pickup_from_warehouse_id": 6,
        "pickup_from_warehouse_name": "Точка на Тверской",
        "delivery_type_id": 1,
        "delivery_type_name": "Самовывоз",
        "payment_type_id": 1,
        "payment_type_name": "Оплата при получении",
        "items": [
          {
            "item": {
              "item_id": 795,
              "item_external_id": null,
              "item_name": "Форма для наращивания",
              "image": "https://[компания].myvirtualpos.ru/data/images/795_1612871937.3154.jpg",
              "quantity": "2.000",
              "unit_base_price": "100.00",
              "discount": "10.00",
              "amount": "190.00"
            }
          }
        ]
      }
    }
  ]
}

Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <count>1</count>
  <orders>
    <order>
      <id>24238</id>
      <customer_id>40823</customer_id>
      <state>NEW</state>
      <assembled/>
      <!-- остальные поля заказа -->
      <items>
        <item>
          <item_id>795</item_id>
          <quantity>2.000</quantity>
          <!-- остальные поля строки -->
        </item>
      </items>
    </order>
  </orders>
</root>

POST https://[компания].myvirtualpos.ru/api/orders/add_order?apikey=MySecret&id=40823
order={"delivery_type_id":1,"payment_type_id":1,"items":[{"item_id":795,"quantity":2,"unit_base_price":100,"discount":10}]}

Поля объекта order

Поля строки заказа (items)

Сумма строки рассчитывается автоматически: unit_base_price × quantity − discount.

{
  "success": 1,
  "order": {
    "delivery_type_id": 1,
    "payment_type_id": 1,
    "customer_id": 40823,
    "shipping_address": "г. Москва, ул. Тверская, д. 3",
    "shipping_cost": "130.00",
    "pickup_from_warehouse_id": 6,
    "external_id": "WEB-1001",
    "comment": "После шести",
    "items": [
      { "item": { "item_id": 795, "quantity": 2, "unit_base_price": 100, "discount": 10, "amount": 190 } }
    ],
    "order_id": 24238
  }
}

В ответе возвращаются переданные данные заказа, а ид созданного заказа — в поле order_id. Полные данные заказа можно получить методом get_order.

POST https://[компания].myvirtualpos.ru/api/orders/update_order?apikey=MySecret&id=24238
order={"paid":1,"state":"PREPARED","comment":"Оплачен"}

Ответ содержит полные данные заказа в том же формате, что и метод get_order: {«success»:1,«order»:{…}}. Если указан state, это должен быть код существующего статуса заказа.

POST https://[компания].myvirtualpos.ru/api/orders/add_orders_item?apikey=MySecret&id=24238
items=[{"item_id":5565,"quantity":1,"unit_base_price":50,"discount":5}]

Три метода работают с массивом items в формате JSON. Заказ определяется параметром id или external_id (только GET). Операции над несколькими строками выполняются в одной транзакции: при ошибке в любой строке не сохраняется ничего.

Во всех случаях в объекте строки нужно указать item_id; вместо него можно передать external_id — код товара из поля guid номенклатуры. Сумма строки пересчитывается по правилу unit_base_price × quantity − discount.

Ответ каждого метода: {«success»:1,«order»:{…}} с полными данными заказа после изменения.

Ошибка авторизации и общие ошибки описаны в статье Общие сведения. Ошибки приходят с кодом HTTP 200 и success равным 0:

Если заказов, подходящих под условия, нет, метод orders возвращает успешный ответ с count равным 0 и пустым списком.