Создание заказа через API

В данной инструкции рассмотрим, как возможно создать заказ через API.

Для этого нужно перейти в "Настройки" - "API", далее нажать на кнопку "Сгенерировать новый api ключ", если его еще не было, затем нажать на кнопку "Сохранить".

Ниже есть пример как создавать заказ по API, нажмите "Показать пример".

{ "OrderCustomer": {
"CustomerId": "b4807dc9-a832-4284-b5c7-de203d8e81aa",
"FirstName": "Иван",
"LastName": "Иванов",
"Patronymic": "Иванович",
"Organization": "ООО Организация",
"Email": "ivan@gmail.com",
"Phone": "790000000",
"Country": "Россия",
"Region": "Москва",
"City": "Москва",
"Zip": "101000",
"CustomField1": "Значение настраиваемого поля 1",
"CustomField2": "Значение настраиваемого поля 2",
"CustomField3": "Значение настраиваемого поля 3",
"Street": "Тверская",
"House": "1",
"Apartment": "1",
"Structure": "",
"Entrance": ""
},
"OrderPrefix": "prefix-",
"OrderSource": "CRM system",
"Currency": "RUB",
"CustomerComment": "Комментарий пользователя",
"AdminComment": "Комментарий администратора",
"ShippingName": "Название доставки",
"PaymentName": "Название оплаты",
"ShippingCost": 100,
"PaymentCost": 0,
"BonusCost": 0,
"OrderDiscount": 0,
"OrderDiscountValue": 100,
"ShippingTaxName": "Название налога для доставки 20%",
"TrackNumber": "123456",
"TotalWeight": 1,
"TotalLength": 100,
"TotalWidth": 100,
"TotalHeight": 100,
"OrderStatusName": "Статус заказа",
"ManagerEmail": "manager@gmail.com",
"IsPaied": true,
"CheckOrderItemExist": true,
"CheckOrderItemAvailable": true,
"OrderItems": [{
"ArtNo": "Артикул 1",
"Name": "Название товара 1",
"Price": 100,
"Amount": 1
},{ "ArtNo": "Артикул 2",
"Name": "Название товара 2",
"Price": 200,
"Amount": 1
}]
}

Для того чтобы создать заказ, нужно послать POST запрос на url, который вы видите, с json данными. В ответ придет json объект с результатом создался ли заказ или с ошибкой.

В примере описаны обязательные и необязательные поля.
Необходимо, чтобы в объекте Order обязательно был OrderCustomer и в объекте OrderCustomer должно быть указано хотя бы одно из полей FirstName, Email, Phone или Organization.

В объекте Order есть поля CheckOrderItemExist и CheckOrderItemAvailable. Они влияют на валидацию при создании заказа.

CheckOrderItemExist - проверять существуют ли товары в магазине. Если стоит true и пришел товар, с артикулом которого нет в магазине, то вернется ошибка и заказ не будет создан. По умолчанию true.

CheckOrderItemAvailable - проверять в наличии ли товары в магазине. Если стоит true и пришел товар, с артикулом товара, который не в наличии, то вернется ошибка и заказ не будет создан. По умолчанию true.

В ответ магазин присылает json. При успешном создании заказа:

{
"result": true
}

Ответ с ошибкой:

{ "result": false,
"errors": [
"Заполните обязательное поле (имя, email, телефон или организацию)"
]
}

Готово. В данной инструкции рассмотрели, как создать заказ через API.