shop.order.calculate

Возвращает информацию о заказе без сохранения в базу данных.

Параметры

• id POST

  ID заказа.

• items POST Необязательно

  Массив с информацией о заказанных модификациях товаров. Подмассив каждой позиции заказа может содержать следующие значения:
  - []['sku_id']: ID модификации товара.
  - []['quantity']: количество модификации товара в заказе в формате decimal(15,3). Если значение не указано, то по умолчанию используется 1.
  - []['price']: цена модификации товара, выраженная в валюте заказа, в формате decimal(15,4). Если значение не указано, то используется цена модификации из таблицы 'shop_product_skus', если модификация не был удалена из каталога товаров.
  - []['total_discount']: скидка на всё количество данной модификации в заказе, выраженная в валюте заказа, в формате decimal(15,4).
  - []['stock_id']: ID склада, с которого нужно списывать остатки заказанной модификации товара. Если значение не указано, то по умолчанию используется id одного из существующих складов.
  - []['virtual_stock_id']: ID виртуального склада, с которого нужно списывать остатки заказанной модификации товара. Если значение не указано, то по умолчанию используется ID одного из существующих виртуальных складов.
  - []['services']: массив информации об услугах, связанных с данным заказанной модификацией товара.
  - []['services'][]['item_id']: ID элемента заказа, являющегося услугой. Если значение указано, то при выполнении метода будет обновлена информация об этой услуге для данного элемента заказа. Если значение не указано и в POST-запросе содержатся значения 'items'[]['services'][]['service_id'] и 'items'[]['services'][]['service_variant_id'], то либо обновится существующая услуга для данного элемента заказа с этими значениями, либо для него будет добавлена новая услуга с этими значениями. Услуги, значения 'items'[]['services'][]['item_id'] которых отсутствуют в POST-запросе для данного элемента заказа, будут удалены из его свойств при выполнении метода.
  - []['services'][]['price']: стоимость услуги, выраженная в валюте заказа, в формате decimal(15,4).
  - []['services'][]['total_discount']: скидка на услугу, выраженная в валюте заказа, в формате decimal(15,4).

• customer POST Необязательно

  Массив информации о покупателе.

• shipping_address GET Необязательно

  Ассоциативный массив полей адреса доставки.

• billing_address GET Необязательно

  Ассоциативный массив полей адреса плательщика.

• discount POST Необязательно

  Информация о скидке:
  - Размер скидки в валюте заказа.
  - null, если не нужно изменять размер скидки.
  - true, если нужно автоматически пересчитать размер скидки.

• params POST Необязательно

  Массив дополнительных параметров заказа для сохранения в таблицу shop_order_params.

• currency POST Необязательно

  3-буквенное обозначение валюты заказа.

• payment_params POST Необязательно

  Ассоциативный массив параметров оплаты.

• shipping_params POST Необязательно

  Ассоциативный массив параметров доставки.

• shipping POST Необязательно

  Стоимость доставки, выраженная в валюте заказа.

• tax POST Необязательно

  Режим сохранения размера налога. Строковое значение 'calculate' означает вычисление размера налога. Пустое значение (null) означает сохранение ранее вычисленного размера налога.

• access_token GET

  Токен авторизации, полученный при подключении к API.

• format GET Необязательно

  Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

Массив с информацией о заказе.

• discount float Размер скидки, выраженный в валюте заказа, в формате decimal(15,4).
• discount_description string Описание скидки.
• items array Состав заказа.
• items[]['id'] int ID элемента заказа.
• items[]['name'] string Название элемента заказа.
• items[]['order_id'] string ID заказа.
• items[]['price'] float Цена элемента заказа, выраженная в валюте заказа, в формате decimal(15,4).
• items[]['product_id'] int ID товара, которому соответствует элемент заказа.
• items[]['purchase_price'] float Закупочная цена элемента заказа, выраженная в валюте заказа, в формате decimal(15,4).
• items[]['quantity'] float Количество элемента заказа в формате decimal(15,3).
• items[]['service_id'] int ID услуги, если элемент заказа является услугой.
• items[]['service_variant_id'] int ID варианта услуги, если элемент заказа является услугой.
• items[]['sku_code'] string Код заказанной модификации товара.
• items[]['sku_id'] int ID заказанной модификации товара.
• items[]['stock_id'] int ID склада, выбранного в свойствах заказа для списания остатков модификации товара.
• items[]['stock_unit_id'] int ID складской единицы измерения количества заказанной модификации товара.
• items[]['tax_included'] int Флаг (0 или 1), означающий, включён ли размер налога в цену заказанного товара.
• items[]['tax_percent'] float Количество процентов применённого налога в формате decimal(15,4).
• items[]['total_discount'] float Размер скидки, рассчитанный для всего количества заказанной модификации товара, выраженный в валюте заказа, в формате decimal(15,4).
• items[]['type'] string Обозначение типа элемента заказа: 'product' (модификация товара) или 'service' (услуга).
• items[]['virtual_stock_id'] int ID виртуального склада, с которого должно выполняться списание остатков заказанной модификации товара.
• shipping float Стоимость доставки, выраженная в валюте заказа, в формате decimal(15,4).
• total float Итоговая стоимость заказа, выраженная в валюте заказа, в формате decimal(15,4).
• subtotal float Стоимость товаров и услуг, без учета скидки, налога и стоимости доставки, выраженная в валюте заказа, в формате decimal(15,4).