Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
Последняя версия Следующая версия справа и слева
doc:dev:api:customer [09.11.2018 10:52]
aderyabin [Параметры запроса]
doc:dev:api:customer [18.06.2020 13:56]
rlysov [Параметры запроса]
Строка 6: Строка 6:
 ===== Пример запроса на получение данных ===== ===== Пример запроса на получение данных =====
  
-Пример запроса на получение данных об остатках товаров:+Пример запроса на получение данных о клиентах:
  
  ​http://​mycompany.virtpos.ru/​api/​customer?​apikey=MySecret&​format=xml  ​http://​mycompany.virtpos.ru/​api/​customer?​apikey=MySecret&​format=xml
  
 +Пример запроса на получение данных о клиентах постранично:​
 +
 + ​http://​mycompany.virtpos.ru/​api/​customer?​apikey=MySecret&​format=xml&​page=1&​page_size=200
 ==== Параметры запроса ==== ==== Параметры запроса ====
  
Строка 18: Строка 21:
   * **id** (get only) - код клиента,​ для которого нужно вернуть данные. Если не указан,​ то возвращаются данные обо всех Клиентах.   * **id** (get only) - код клиента,​ для которого нужно вернуть данные. Если не указан,​ то возвращаются данные обо всех Клиентах.
   * **external_id** (get only) - код Клиента во внешней системе,​ для которого нужно вернуть данные. Если не указан,​ то возвращаются данные обо всех Клиентах.   * **external_id** (get only) - код Клиента во внешней системе,​ для которого нужно вернуть данные. Если не указан,​ то возвращаются данные обо всех Клиентах.
-  * **phone** - телефон клиента в свободной форме +  * **phone** - телефон клиента в свободной форме. 
-  * **email** - адрес электронной почты клиента +  * **email** - адрес электронной почты клиента. 
 +  * **with_phone** - true: получить клиентов,​ у которых указан телефон;​ false: получить клиентов без телефона. 
 +  * **with_email** - true: получить клиентов,​ у которых указан адрес электронной почты; false: получить клиентов без адреса электронной почты. 
 +  * **page** - номер страницы (для постраничного запроса). 
 +  * **page_size** - размер страницы (для постраничного запроса). 
 +  * **cards** - true: в ответ будут добавлены данные о картах лояльности клиента. false - получить данные без карт (по умолчанию) 
 +  * **bonuses** - true: в ответ будут добавлены данные о бонусных накоплениях клиента. false - получить данные без бонусов (по умолчанию)
  
 ==== Ответ сервера ==== ==== Ответ сервера ====
  
-В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info+В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
  
  
Строка 68: Строка 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>​
 ===== Пример запроса на добавление/​изменение данных ===== ===== Пример запроса на добавление/​изменение данных =====