shop.order.addSale
Создает новый заказ-продажу. Такие заказы попадают в отдельный статус и указание покупателя для них необязательно.
Параметры
-
items
POST
Список позиций заказа. Каждый элемент списка — массив со следующими ключами:
- sku_id: ID модификации товара.
- product_id: ID товара (для услуг).
- service_id: ID услуги.
- service_variant_id: ID варианта услуги.
- price: Цена товара или услуги.
- quantity: Количество товара.
- codes: Товарные коды для каждой из единиц товара. Каждый элемент списка — массив со следующими ключами: 'code' (идентификатор кода), 'value' (значение кода для данной единицы товара). -
contact_id
POST
Необязательно
ID покупателя.
-
currency
POST
Необязательно
ISO-код валюты.
-
params
POST
Необязательно
Дополнительные параметры заказа.
-
discount
POST
Необязательно
Размер скидки.
-
coupon_id
POST
Необязательно
ID купона на скидку.
-
comment
POST
Необязательно
Комментарий к заказу.
-
format
GET
Необязательно
Устанавливает формат ответа. Возможные значения:
json
(по умолчанию),xml
.
Возвращаемое значение
Массив с информацией о заказе со следующими ключами:
- id int ID заказа.
- contact_id int ID контакта покупателя.
- create_datetime datetime Дата и время создания заказа.
- state_id string Идентификатор статуса заказа. Список идентификаторов всех настроенных в магазине статусов можно получить с помощью метода
shop.settings.get
— значения будут доступны в поле ответа order_states. - total float Стоимость заказа, выраженная в валюте заказа, в формате
decimal(15,4)
. - currency string Идентификатор валюты заказа в формате ISO 4217.
- rate float Курс валюты заказа по отношению к основной валюте магазина.
- tax float Размер применённого налога, выраженный в валюте заказа, в формате
decimal(15,4)
. - discount float Размер скидки, выраженный в валюте заказа, в формате
decimal(15,4)
. - is_first int Флаг (0 или 1), обозначающий первый оплаченный заказ покупателя.
- unsettled int Флаг (0 или 1), обозначающий, является ли заказ подвешенным.
- comment string Комментарий к заказу, оставленный покупателем.
- params array Массив дополнительных параметров заказа.
- params['shipping_id'] int ID выбранного варианта доставки.
- params['payment_id'] int ID выбранного варианта оплаты.
- params['departure_datetime'] datetime Дата и время, начиная с которого заказ считается готовым к отправке.
- params['coupon_id'] int ID применённого купона на скидку.
- params['sales_channel'] string Обозначение канала продаж: 'backend:' (заказ создан администратором в панели управления магазина), 'storefront:...' (заказ оформлен на витрине магазина), 'buy_button:' (заказ оформлен через виджет товара «Купить»).
- contact array Массив свойств покупателя со следующими ключами:
- contact['id'] int ID контакта.
- contact['name'] string Полное имя.
- contact['email'] string Email-адрес.
- contact['phone'] string Номер телефона.
- contact['registered'] bool Признак регистрации покупателя для входа в личный кабинет с паролем.
- contact['photo_50x50'] string URL фотографии покупателя либо ссылка на его юзерпик в сервисе Gravatar.
- items array Массив со списком заказанных товаров и услуг:
- items[]['id'] int ID элемента заказа.
- items[]['order_id'] string ID заказа.
- items[]['name'] string Название элемента заказа.
- items[]['product_id'] int ID товара, которому соответствует элемент заказа.
- items[]['sku_id'] int ID заказанной модификации товара.
- items[]['sku_code'] string Код заказанного артикула.
- items[]['type'] string Обозначение типа элемента заказа: 'product' (модификация товара) или 'service' (услуга).
- items[]['service_id'] int ID услуги, если элемент заказа является услугой.
- items[]['service_variant_id'] int ID варианта услуги, если элемент заказа является услугой.
- items[]['price'] float Цена элемента заказа, выраженная в валюте заказа, в формате
decimal(15,4)
. - items[]['quantity'] float Количество элемента заказа в формате в формате
decimal(15,3)
. - items[]['quantity_denominator'] int Доступная точность указания складских остатков товара: 1 (целые штуки), 10 (точность до десятых), 100 (точность до сотых), 1000 (точность до тысячных).
- items[]['stock_id'] int ID склада, выбранного в свойствах заказа для списания остатков модификации товара.
- items[]['virtual_stock_id'] int ID виртуального склада, с которого должно выполняться списание остатков заказанной модификации товара.
- items[]['purchase_price'] float Закупочная цена элемента заказа, выраженная в валюте заказа, в формате
decimal(15,4)
. - items[]['total_discount'] float Размер скидки, рассчитанный для всего количества заказанной модификации товара, выраженный в валюте заказа, в формате
decimal(15,4)
. - items[]['tax_percent'] float Количество процентов применённого налога в формате
decimal(15,4)
. - items[]['tax_included'] int Флаг (0 или 1), означающий, включён ли размер налога в цену заказанного товара.
- items[]['stock_unit_id'] int ID складской единицы измерения количества заказанной модификации товара.
- items[]['image_id'] int ID изображения товара из свойств заказанной модификации товара.