Инструменты пользователя

Инструменты сайта


api_передача_заказов

Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
api_передача_заказов [2017/06/02 20:16]
Максим [Метод CreateOrder]
api_передача_заказов [2017/06/05 11:18] (текущий)
Алексей
Строка 32: Строка 32:
 Параметры метода передаются в массиве '''​params'''​. Параметры,​ помеченные звездочкой* обязательны,​ остальные можно не передавать. Параметры метода передаются в массиве '''​params'''​. Параметры,​ помеченные звездочкой* обязательны,​ остальные можно не передавать.
  
-|Ключ |Тип |Описание |||  ​+|Ключ |Тип |Описание ||| 
-|name* |Строка |Имя клиента в свободной форме |||  ​+|name* |Строка |Имя клиента в свободной форме ||| 
-|phone* |Строка |Номер телефона клиента в свободной форме |||  ​+|phone* |Строка |Номер телефона клиента в свободной форме ||| 
-|external_id* |Строка |Идентификатор заказа на внешней витрине,​ необходим для защиты от дублирования заказов. Если вы не храните на внешней витрине заказы,​ то можно передавать в данный параметр текущие дату+время |||  ​+|external_id* |Строка |Идентификатор заказа на внешней витрине,​ необходим для защиты от дублирования заказов. Если вы не храните на внешней витрине заказы,​ то можно передавать в данный параметр текущие дату+время ||| 
-|products* |   \\ Массив |  Массив списка товаров для заказа состоит из списка объектов с полями|||  ​+|products* |  Массив ​ |  Массив списка товаров для заказа состоит из списка объектов с полями ​ ||| 
-|  |::: | Ключ |Тип |Описание ​|  ​+|:::  |::: | Ключ |Тип |Описание | 
-|  |::: | id* |Число |Артикул товара<font 14px/​inherit;;​inherit;;​inherit>,</​font> ​   ​можно узнать<font 14px/​inherit;;​inherit;;​inherit>​в</​font> ​   ​библиотеке товаров ​|  ​+|:::  |::: | id* |Число |Артикул товара можно узнать в библиотеке товаров ​    ​
-|  |::: | quantity* |Число |Количество товаров<font 14px/​inherit;;​inherit;;​inherit>​в</​font> ​    <​font 14px/​inherit;;​inherit;;​inherit>​заказе</​font> ​    ​|  ​+|:::  |::: | quantity* |Число |Количество товаров в заказе | 
-|  |::: | price |Число |Желаемая цена товара \\ Если<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> ​   ​платформе<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> ​   ​котором бонус равен нулю<font 14px/​inherit;;​inherit;;​inherit>​.</​font> ​    ​|  ​+|:::  |::: | price |Число |   \\ Желаемая цена товара ​\\   \\ ​ \\ Если не передана или передан ноль/​пустое значение,​ то устанавливается текущая розничная цена по платформе + доп. наценка витрины \\  \\ ​Может быть выше текущей розничной цены по платформе соответственно партнерский бонус с продажи будет выше ​\\  ​\\ Может быть ниже текущей розничной цены по платформе,​ за счет партнерского бонуса. Но не ниже уровня,​ при котором бонус равен нулю. | 
-|  |  |name |Строка |Название товара в вашем магазине |  |+|:::  |:::  |name |Строка |Название товара в вашем магазине | 
 +|address |Строка |Адрес клиента в свободной форме ||| 
 +|secondaryPhone |Строка |Дополнительный телефон клиента,​ на случай если первый телефон не доступен ||| 
 +|email |Строка |Email клиента ||| 
 +|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 ​
  
-|Ключ |Тип |  |Описание | 
-|name* |Строка |::: | Имя клиента в свободной форме | 
-|phone* |Строка |::: | Номер телефона клиента в свободной форме | 
-|external_id* |Строка |::: | Идентификатор заказа на внешней витрине,​ необходим для защиты от дублирования заказов. Если вы не храните на внешней витрине заказы,​ то можно передавать в данный параметр текущие дату+время | 
-|products* |Массив |::: | Массив списка товаров для заказа состоит из списка объектов с полями:​ | 
- 
-|  |  |  |  |  |  |  |Ключ |Тип |Описание | 
-|  |  |  |  |  |  |id* |Число |Артикул товара,​ можно узнать в библиотеке товаров |  | 
-|  |  |  |  |  |  |quantity* |Число |Количество товаров в заказе |  | 
-|  |  |  |  |  |  |price |Число |Желаемая цена товара \\   \\ Если <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> ​   платформе<​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> ​   котором бонус равен нулю |  | 
-|  |  |  |  |  |  |name |Строка |Название товара в вашем магазине |  | 
-|  |  |  |  |  |  |  |  |  |  | 
- 
-| 
  
 В ответ на запрос сервер вернёт:​ В ответ на запрос сервер вернёт:​
  
-|Код |Описание | +|Код |Описание ​||
-|201 |Заказ успешно создан,​ в ответе будет JSON массив со следующими полями:​ | +|201 |Заказ успешно создан,​ в ответе будет JSON массив со следующими полями:​ ||| 
- +|::: | Ключ |Тип |Описание | 
-  |Ключ |Тип |Описание | +|::: | status |Строка |статус создания ​«Ок» 
- ​|  ​|status |Строка |статус создания ​"Ок" ​+|::: | order_id |Число |Номер созданного заказа | 
- ​|  ​|order_id |Число |Номер созданного заказа | +|::: | order_url |Строка |ссылка на заказ на витрине платформы,​ по данной ссылке можно делать редирект для клиента,​ чтобы он мог выбрать способ оплаты или ознакомиться с заказом | 
- ​|  ​|order_url |Строка |ссылка на заказ на витрине платформы,​ по данной ссылке можно делать редирект для клиента,​ чтобы он мог выбрать способ оплаты или ознакомиться с заказом ​+|400 |Ошибка во вводных данных,​ в ответе будет JSON массив со следующими полями:​ ||| 
- +|::: | Ключ |Тип |Описание | 
-|Код |Описание ​+|::: | status |Строка |статус создания, ​«ERROR» ​
-|400 |   \\ Ошибка во вводных данных,​ в ответе будет JSON массив со следующими полями:​ | +|::: | errors |Массив |массив ошибок в формате JSON |
- +
-  |Ключ |Тип |Описание | +
- ​|  ​|status |Строка |статус создания, ​"​ERROR" ​+
- ​|  ​|errors |Массив |массив ошибок в формате JSON |+
  
 \\ \\
  
api_передача_заказов.1496423777.txt.gz · Последние изменения: 2017/06/02 20:16 — Максим