API :: Customer. Получение/изменение данных о Клиентах

В системе реализован программный интерфейс для получения, добавления и изменения данных о Клиентах (покупателях). Данные выгружаются по http протоколу. Формат на выбор - xml или json.

Пример запроса на получение данных об остатках товаров:

http://mycompany.virtpos.ru/api/customer?apikey=MySecret&format=xml

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• id - код Клиента, для которого надо вернуть данные. Если не указан, то возвращаются данные обо всех Клиентах.

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info

Ниже приведен пример ответа сервера в формате XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<type>customer</type>
	<count>2</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>
</root>

Пример запроса на получение данных о точке продаж:

http://mycompany.virtpos.ru/api/customer/update?apikey=MySecret&create_if_not_exist=0

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• id - код магазина, данные которого надо обновить

• create_if_not_exist - Если истина, то при неудачном поиске магазин будет добавлен в систему.

• group_name - Название клиентской группы. Если значение указано, то происходит проверка, есть ли группа с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется, если указан group_id

• Также в качестве параметров могут быть переданы все поля для Клиента (fname, lname, email и т.д.). Поле age(возраст) передавать нельзя - оно рассчитывается автоматически на основе данных о дате рождения клиента.

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.

Также возвращается id записи, которая была обновлена или добавлена. Флаг isnew равен «1», если запись была создана, и «0» если обновлена.

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<success>1</success>
	<id>11</id>
	<isnew>1</isnew>
</root>