Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:customer [29.08.2019 10:46]
dlebedev [Ответ сервера]
doc:dev:api:customer [27.09.2021 11:44] (текущий)
amalchenko [Пример запроса на добавление/изменение данных]
Строка 27: Строка 27:
   * **page** - номер страницы (для постраничного запроса).   * **page** - номер страницы (для постраничного запроса).
   * **page_size** - размер страницы (для постраничного запроса).   * **page_size** - размер страницы (для постраничного запроса).
 +  * **cards** - true: в ответ будут добавлены данные о картах лояльности клиента. false - получить данные без карт (по умолчанию)
 +  * **bonuses** - true: в ответ будут добавлены данные о бонусных накоплениях клиента. false - получить данные без бонусов (по умолчанию)
  
 ==== Ответ сервера ==== ==== Ответ сервера ====
Строка 74: Строка 76:
 </​file>​ </​file>​
  
 +При постраничном запросе ответ содержит дополнительные поля:
  
 +<file xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​root>​
 + <​success>​1</​success>​
 + <​type>​customer</​type>​
 + <​count>​200</​count>​
 + <​customers>​
 + <​customer>​
 + <​id>​1</​id>​
 + <​fname>​Сергей</​fname>​
 + <​lname>​Иванов</​lname>​
 + <​mname>​Степанович</​mname>​
 + <​age>​24</​age>​
 + <​email/>​
 + <​phone/>​
 + <​gender>​F</​gender>​
 + <​custom_information>​очень требовательный</​custom_information>​
 + <​birth_day>​24</​birth_day>​
 + <​birth_month>​10</​birth_month>​
 + <​birth_year>​1992</​birth_year>​
 + <​register_date>​2016-07-18 13:​54:​37</​register_date>​
 + <​accumulated_sales>​15200</​accumulated_sales>​
 + <​send_push>​1</​send_push>​
 + <​send_email>​1</​send_email>​
 + <​send_sms>​1</​send_sms>​
 + <​group_id/>​
 + <​group_name/>​
 + <​created_date>​2016-07-18 13:​54:​37</​created_date>​
 + <​created_by>​2</​created_by>​
 + <​last_update_date>​2016-07-18 13:​54:​37</​last_update_date>​
 + <​last_update_by>​2</​last_update_by>​
 + </​customer>​
 + </​customers>​
 +        <​page>​1</​page>​
 +        <​page_size>​200</​page_size>​
 +        <​total_count>​3000</​total_count>​
 +</​root>​
 +</​file>​
 ===== Пример запроса на добавление/​изменение данных ===== ===== Пример запроса на добавление/​изменение данных =====
  
-Пример запроса на получение данных о точке продаж:+Пример запроса на получение данных о клиенте:
  
  ​http://​mycompany.virtpos.ru/​api/​customer/​update?​apikey=MySecret&​create_if_not_exist=0  ​http://​mycompany.virtpos.ru/​api/​customer/​update?​apikey=MySecret&​create_if_not_exist=0
Строка 89: Строка 130:
   * **id** (get only) - код клиента,​ данные которого надо обновить   * **id** (get only) - код клиента,​ данные которого надо обновить
  
-  * **create_if_not_exist** (get only) - Если истина,​ то при неудачном поиске ​магазин будет добавлен в систему.+  * **create_if_not_exist** (get only) - Если истина,​ то при неудачном поиске ​клиент будет добавлен в систему.
    
   * **group_name** (get или post)- Название клиентской группы. Если значение указано,​ то происходит проверка,​ есть ли группа с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется,​ если указан group_id   * **group_name** (get или post)- Название клиентской группы. Если значение указано,​ то происходит проверка,​ есть ли группа с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется,​ если указан group_id
Строка 143: Строка 184:
 ===== insertCard - добавление дисконтной карты ===== ===== insertCard - добавление дисконтной карты =====
 Добавление новой дисконтной карты. Параметры запроса аналогичны updateCard ​ Добавление новой дисконтной карты. Параметры запроса аналогичны updateCard ​
 +
 +
 +===== updateBonus - изменение бонусных накоплений клиента =====
 +Начисляет\списывает бонусные баллы с клиента.
 +
 +Параметры запроса:​
 +  * (int) **customer_id** - код клиента,​ для которого нужно вернуть данные. Если не указан customer_external_id,​ то параметр обязательный.
 +  * (string) **customer_external_id** - код Клиента во внешней системе,​ для которого нужно вернуть данные. Если не указан customer_id,​ то параметр обязательный.
 +  * (int) **bonus_id** - идентификатор бонусной программы. Обязательный параметр.
 +  * (float) **amount** -  сумма начисления (если отрицательная,​ то списания). Обязательный параметр
 +  * (bool) **overwrite** - если true, то заменяет текущие бонусные накопления клиента на сумму amount. Иначе добавляет amount к имеющимся накоплениям. По умолчанию false