Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
api_передача_заказов [2017/06/02 21:31] Алексей |
api_передача_заказов [2017/06/05 11:18] (текущий) Алексей |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
====== API передачи заказов Qnits ====== | ====== API передачи заказов Qnits ====== | ||
+ | |||
===== Основная информация ===== | ===== Основная информация ===== | ||
- | Для обмена данными с API Qnits используется формат JSON. | + | Для обмена данными с API Qnits используется формат JSON. |
+ | |||
+ | Запросы в формате JSON передаются методом HTTP POST на следующий адрес: | ||
+ | [[http://api.qnits.ru/api|http://api.qnits.ru/api]] либо [[http://ваш_домен/api|http://ваш_домен/api]] | ||
- | Запросы в формате JSON передаются методом HTTP POST на следующий адрес: [[http://api.qnits.ru/api|http://api.qnits.ru/api]] либо [[http://ваш_домен/api|http://ваш_домен/api]] | ||
Запрос всегда содержит: | Запрос всегда содержит: | ||
Строка 11: | Строка 14: | ||
* ключ method с именем вызываемого метода | * ключ method с именем вызываемого метода | ||
* ключ qnit_id с номером витрины | * ключ qnit_id с номером витрины | ||
- | * ключ token - авторизационный токен | + | * ключ token - авторизационный токен |
* ключ params - список параметров для вызываемого метода | * ключ params - список параметров для вызываемого метода | ||
- | Параметры qnit_id и token можно узнать в менеджер панели по адресу [[http://panel.qnits.ru/manager_mvc/settings/api|http://panel.qnits.ru/manager_mvc/settings/api]] | + | Параметры qnit_id и token можно узнать в менеджер панели по адресу |
+ | [[http://panel.qnits.ru/manager_mvc/settings/api|http://panel.qnits.ru/manager_mvc/settings/api]] | ||
==== Метод "CreateOrder" ==== | ==== Метод "CreateOrder" ==== | ||
Строка 23: | Строка 28: | ||
''{ "token": "541c4a59bdad87039c7ae8df6af14785сaf7526f01a613f5bd894d615ee811e5", "qnit_id": 1, "method": "CreateOrder", "params": { "name": "Иванов Иван", "phone": "79123211232", "external_id": "2643", <nowiki>"products": [</nowiki> { "id": 1000587, "quantity": 1, }, { "id": 3044, "quantity": 2 } ] } }'' | ''{ "token": "541c4a59bdad87039c7ae8df6af14785сaf7526f01a613f5bd894d615ee811e5", "qnit_id": 1, "method": "CreateOrder", "params": { "name": "Иванов Иван", "phone": "79123211232", "external_id": "2643", <nowiki>"products": [</nowiki> { "id": 1000587, "quantity": 1, }, { "id": 3044, "quantity": 2 } ] } }'' | ||
- | |||
=== Параметры === | === Параметры === | ||
Строка 33: | Строка 37: | ||
|external_id* |Строка |Идентификатор заказа на внешней витрине, необходим для защиты от дублирования заказов. Если вы не храните на внешней витрине заказы, то можно передавать в данный параметр текущие дату+время ||| | |external_id* |Строка |Идентификатор заказа на внешней витрине, необходим для защиты от дублирования заказов. Если вы не храните на внешней витрине заказы, то можно передавать в данный параметр текущие дату+время ||| | ||
|products* | Массив | Массив списка товаров для заказа состоит из списка объектов с полями ||| | |products* | Массив | Массив списка товаров для заказа состоит из списка объектов с полями ||| | ||
- | | |::: | Ключ |Тип |Описание | | + | |::: |::: | Ключ |Тип |Описание | |
- | | |::: | id* |Число |Артикул <font 14px/inherit;;inherit;;inherit>товара</font> <font 14px/inherit;;inherit;;inherit>,</font> можно <font 14px/inherit;;inherit;;inherit>уз</font> <font 14px/inherit;;inherit;;inherit>нать</font> <font 14px/inherit;;inherit;;inherit>в</font> б<font 14px/inherit;;inherit;;inherit>иб</font> <font 14px/inherit;;inherit;;inherit>лиотеке</font> <font 14px/inherit;;inherit;;inherit>товаров</font> | | + | |::: |::: | id* |Число |Артикул товара можно узнать в библиотеке товаров | |
- | | |::: | quantity* |Число |Количество товаров в заказе | | + | |::: |::: | quantity* |Число |Количество товаров в заказе | |
- | | |::: | price |Число | \\ Желаемая цена товара \\ \\ \\ Если <font inherit/inherit;;inherit;;inherit>не</font> передана <font inherit/inherit;;inherit;;inherit>или</font> передан ноль/пустое значение, то устанавливается текущая розничная цена <font inherit/inherit;;inherit;;inherit>по</font> платформе + доп. наценка витрины \\ \\ Может быть выше текущей розничной цены <font inherit/inherit;;inherit;;inherit>по</font> платформе соответственно партнерский бонус <font inherit/inherit;;inherit;;inherit>с</font> продажи будет выше \\ \\ Может быть ниже текущей розничной цены <font inherit/inherit;;inherit;;inherit>по</font> платформе, за счет партнерского бонуса. Но не ниже уровня, при котором бонус равен нулю. | | + | |::: |::: | price |Число | \\ Желаемая цена товара \\ \\ \\ Если не передана или передан ноль/пустое значение, то устанавливается текущая розничная цена по платформе + доп. наценка витрины \\ \\ Может быть выше текущей розничной цены по платформе соответственно партнерский бонус с продажи будет выше \\ \\ Может быть ниже текущей розничной цены по платформе, за счет партнерского бонуса. Но не ниже уровня, при котором бонус равен нулю. | |
- | | |::: | |name |Строка |Название товара в вашем магазине | | + | |::: |::: |name |Строка |Название товара в вашем магазине | |
|address |Строка |Адрес клиента в свободной форме ||| | |address |Строка |Адрес клиента в свободной форме ||| | ||
|secondaryPhone |Строка |Дополнительный телефон клиента, на случай если первый телефон не доступен ||| | |secondaryPhone |Строка |Дополнительный телефон клиента, на случай если первый телефон не доступен ||| | ||
|email |Строка |Email клиента ||| | |email |Строка |Email клиента ||| | ||
|comments |Строка |Комментарий(Виден клиенту) ||| | |comments |Строка |Комментарий(Виден клиенту) ||| | ||
+ | |clientIpAddress | Строка| ip адрес клиента в формате ipv4\\ \\ Осторожно используйте данный параметр — если переданный адрес не будет принадлежать клиенту, заказ может быть определен как подозрительный ||| | ||
+ | |utmParams | Массив| Массив UTM меток ||| | ||
+ | |::: |::: | Ключ | Тип | Описание | | ||
+ | |::: |::: | utm_cid | Строка | субаккаунт | | ||
+ | |::: |::: | utm_source | Строка | Метка utm_source | | ||
+ | |::: |::: | utm_medium | Строка | Метка utm_medium | | ||
+ | |::: |::: | utm_campaign | Строка | Метка utm_campaign | | ||
+ | |::: |::: | utm_content | Строка | Метка utm_content | | ||
+ | |::: |::: | utm_term | Строка | Метка utm_term | | ||
+ | |||
В ответ на запрос сервер вернёт: | В ответ на запрос сервер вернёт: |