addOrder — создание заказа из внешних систем
Запрос
POST https://[домен]/engine/orders/addOrder
где [домен] — адрес вашего интернет-магазина;
В теле запроса ожидается JSON структура с данными о заказе, который необходимо создать на сайте. После создания покупателю будет отправлено письмо о созданном заказе.
Пример запроса
{
"key": "article",
"order": {
"user": {
"mail": "mail@mail.ru",
"phone": "77777777777",
"name": "ФИО_клиента_или_название_компании"
},
"status": 1,
"payment_type": "yandex_kassa",
"goods": [
{
"article": "а-1111",
"name": "Наименование товара №1",
"qt": 4,
"price": 100
},
{
"article": "a-2222",
"name": "Наименование товара №2",
"qt": 2,
"price": 1000
}
]
}
}
Описание полей JSON структуры запроса:
key – ключевое поле, по которому можно однозначно идентифицировать товар на сайте. Возможные варианты:
- code – синхронизация по коду справочника Номенклатура;
- article – синхронизация по артикулу;
- variant – синхронизация по guid товара и guid характеристики;
order – структура с описанием параметров создаваемого заказа
user – структура параметров с данными о заказчике.
mail - email пользователя (обязательно). Если пользователь с таким email зарегистрирован на сайте, то заказ будет привязан к его профилю. Если нет - будет создан новый пользователь.
phone - номер телефона пользователя (необязательно).
name - имя пользователя (необязательно).
payment – тип оплаты (необязательно). Если это предусмотрено способом оплаты, то в письме с уведомлением о заказе пользователю будет вставлена ссылка на онлайн-оплату. Возможные варианты (данные варианты должны быть предварительно подключены на стороне сайта):
- sber_card — оплата через эквайринг от Сбербанка
- sber_installment — оплата через рассрочку от Сбербанка
- sber_credit — оплата через кредит от Сбербанка
- sber_QR — оплата по QR коду от Сбербанка
- yandex_card— оплата через Яндекс.Касса
- paykeeper_card — оплата через PayKeeper
- other — любой другой способ оплаты
status – статус нового заказа:
- 0 – размещен
- 1 – в обработке
- 2 – завершен
- 3 – оплачен
- 4 - отменен
- 5 - ожидает оплаты
goods – массив структур с описанием состава заказа
code – код товара в 1С (требуется, если key=code);
article – артикул товара (требуется, если key=article);
variant – идентификатор товара из 1С (вплоть до характеристики номенклатуры, если она используется в 1С). Состоит из GUID товара и GUID характеристики, разделенных знаком «~». Если характеристика не используется, то только GUID товара. Требуется, если key=variant;
name – наименование товара (будет использоваться, если товара по ключевому полю на сайте не найдено, но необходимо, чтобы в заказе покупателя этот товар появился);
qt – количество товара в заказе;
price – цена товара в заказе;
Пример ответа сервера:
{
"success": true,
"orderId": 4
}
Описание полей в ответе сервера:
success — признак корректности обработки запроса;
orderId — идентификатор созданного заказа.
textError — текстовое описание возможной ошибки