Команда addClient
создает клиента. Атрибуты клиента задаются обязательным параметром client
.
Свойства параметра client
:
Свойство | Тип данных | Описание | Примечания | |
---|---|---|---|---|
idclient | строковый(100) | Идентификационный номер клиента | ||
name | строковый(200) | ФИО клиента | ||
text | строковый(200) | Текст | ||
sex | числовой(11) | Пол клиента:
| ||
birthday | дата | День рождения, год рождения должен быть больше 1900 | ||
specialdate1 | дата | Первая особая дата клиента | ||
specialdate2 | дата | Вторая особая дата клиента | ||
specialdate3 | дата | Третья особая дата клиента | ||
specialdate1name | строковый(200) | Название первой особой (специальной) даты | ||
specialdate2name | строковый(200) | Название второй особой (специальной) даты | ||
specialdate3name | строковый(200) | Название третьей особой (специальной) даты | ||
zipcode | строковый(200) | Почтовый индекс клиента | ||
address | строковый(200) | Адрес клиента | ||
строковый(200) | ||||
webpage | строковый(200) | Web-страница | ||
phonenumber | строковый(200) | Телефонный номер клиента | ||
inn | строковый(200) | ИНН | ||
document | строковый(200) | Данные документа клиента (паспорта, водительского удостоверения и т.д.) | ||
okpo | строковый(200) | ОКПО | ||
okpd | строковый(200) | ОКПД | ||
occupation | строковый(200) | Род занятий | ||
childrencount | числовой(11) | Количество детей клиента | ||
extendedoptions | строковый | Дополнительные параметры | ||
organizationcode | строковый(255) | Уникальный код организации | ||
subscriptionadj | числовой(11) | Согласие клиента на рассылку:
| ||
options | числовой(11) | Опции, установленные для клиента (битовая маска):
|
Для отправки чека на e-mail необходимо установить Подробнее о функционале отправки чеков на электронную почту можно прочитать в разделе "Отправка чека на адрес покупателя". | |
lastname | строковый(255) | Фамилия | ||
patronymic | строковый(255) | Отчество | ||
communications | числовой(11) | Разрешенные каналы связи (битовая маска):
|
Свойства объекта options:
Свойство | Тип данных | Описание | Примечания |
---|---|---|---|
sendCheckToEmail | числовой(1) | Отправка чека на e-mail:
| По умолчанию 0 |
emailConfirmed | числовой(1) | e-mail пользователя подтвержден:
| По умолчанию 0 |
Свойства объекта communications:
Свойство | Тип данных | Описание | Примечания |
---|---|---|---|
call | числовой(1) | Вызов на телефон:
| По умолчанию 0 |
telegram | числовой(1) | Сообщение в Telegram:
| По умолчанию 0 |
sms | числовой(1) | SMS:
| По умолчанию 0 |
числовой(1) | Письмо на электронную почту:
| По умолчанию 0 |
{ "client": { "idclient": 4, "name": "Пётр", "lastname": "Петров", "patronymic": "Петрович", "communications": { "call": 1, "telegram": 0, "sms": 1 }, "text": "text", "sex": 0, "birthday": "1966-05-20", "specialdate1": "1980-08-08", "specialdate2": "", "specialdate3": "", "specialdate1name": "День свадьбы", "specialdate2name": "", "specialdate3name": "", "zipcode": "656000", "address": "Ленина 108-46", "email": "ivanov@gmail.ru", "webpage": "", "phonenumber": "", "inn": "", "document": "", "okpo": "", "okpd": "", "occupation": "Сантехник", "childrencount": 8, "extendedoptions": "", "organizationcode": "1", "subscriptionadj": "1", "options": { "sendchecktoemail" : 1, "emailconfirmed" : 1 } }, "command": "addClient" } |
Команда clearClient
очищает справочник клиентов:
{ "command": "clearClient" } |
Параметр: идентификационный номер клиента.
{ "idclient": 12, "command": "deleteClient" } |
Команда updateClient
обновляет данные об уже существующем клиенте. Атрибуты клиента задаются обязательным параметром client
. При обновлении используется idclient
, в остальном следует указывать только изменяемые атрибуты.
Свойства параметра client
.
Свойство | Тип данных | Описание | Примечания | |
---|---|---|---|---|
idclient | строковый(100) | Идентификационный номер клиента | ||
name | строковый(200) | ФИО клиента | ||
text | строковый(200) | Текст | ||
sex | числовой(11) | Пол клиента:
| ||
birthday | дата | День рождения, год рождения должен быть больше 1900 | ||
specialdate1 | дата | Первая особая дата клиента | ||
specialdate2 | дата | Вторая особая дата клиента | ||
specialdate3 | дата | Третья особая дата клиента | ||
specialdate1name | строковый(200) | Название первой особой(специальной) даты | ||
specialdate2name | строковый(200) | Название второй особой(специальной) даты | ||
specialdate3name | строковый(200) | Название третьей особой(специальной) даты | ||
zipcode | строковый(200) | Почтовый индекс клиента | ||
address | строковый(200) | Адрес клиента | ||
строковый(200) | ||||
webpage | строковый(200) | Web-страница | ||
phonenumber | строковый(200) | Телефонный номер клиента | ||
inn | строковый(200) | ИНН | ||
document | строковый(200) | Данные документа клиента (паспорта, водительского удостоверения и т.д.) | ||
okpo | строковый(200) | ОКПО | ||
okpd | строковый(200) | ОКПД | ||
occupation | строковый(200) | Род занятий | ||
childrencount | числовой(11) | Количество детей клиента | ||
extendedoptions | строковый | Дополнительные параметры | ||
organizationcode | строковый(255) | Уникальный код организации | ||
subscriptionadj | числовой(11) | Согласие клиента на рассылку:
| ||
options | числовой(11) | Опции, установленные для клиента (битовая маска):
|
Для отправки чека на e-mail необходимо установить Подробнее о функционале отправки чеков на электронную почту можно прочитать в разделе "Отправка чека на адрес покупателя". | |
lastname | строковый(255) | Фамилия | ||
patronymic | строковый(255) | Отчество | ||
communications | числовой(11) | Разрешенные каналы связи (битовая маска):
|
Свойства объекта options:
Свойство | Тип данных | Описание | Примечания |
---|---|---|---|
sendCheckToEmail | числовой(1) | Отправка чека на e-mail:
| По умолчанию 0 |
emailConfirmed | числовой(1) | e-mail пользователя подтвержден:
| По умолчанию 0 |
Свойства объекта communications:
Свойство | Тип данных | Описание | Примечания |
---|---|---|---|
call | числовой(1) | Вызов на телефон:
| По умолчанию 0 |
telegram | числовой(1) | Telegram:
| По умолчанию 0 |
sms | числовой(1) | SMS:
| По умолчанию 0 |
числовой(1) | Письмо на электронную почту:
| По умолчанию 0 |
{ "command": "updateClient", "client": { "idclient": 4, "name": "Иван Иванов", "sex": 0, "phonenumber": "88005559999", "address": "ivan@mail.ru" } } |