Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:customer [29.08.2019 10:50] 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 - получить данные без бонусов (по умолчанию) | ||
| ==== Ответ сервера ==== | ==== Ответ сервера ==== | ||
| Строка 116: | Строка 118: | ||
| ===== Пример запроса на добавление/изменение данных ===== | ===== Пример запроса на добавление/изменение данных ===== | ||
| - | Пример запроса на получение данных о точке продаж: | + | Пример запроса на получение данных о клиенте: |
| 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 | ||
| Строка 128: | Строка 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 | ||
| Строка 182: | Строка 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 | ||