№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
3 | name | string | имя пользователя | Не обязательное поле. | |
4 | userlogin | string | логин пользователя | Не обязательное поле. | |
5 | userpass | string | пароль пользователя | Не обязательное поле. | |
6 | string | email пользователя | Обязательное поле (или email или телефон должен быть). | ||
7 | phone | string | телефон пользователя | Обязательное поле (или email или телефон должен быть). | |
8 | address | string | полный адрес пользователя одной строкой (устаревший параметр) | Не обязательное поле. | |
9 | country | string | Страна | Не обязательное поле. | |
10 | region | string | Регион (область) | Не обязательное поле. | |
11 | district | string | Район | Не обязательное поле. | |
12 | city | string | Название населенного пункта | Не обязательное поле. | |
13 | street | string | Улица | Не обязательное поле. | |
14 | street_number | string | номер дома | Не обязательное поле. | |
15 | apartment | string | квартира | Не обязательное поле. | |
16 | bdate | date | день рождение пользователя | Не обязательное поле. | |
17 | parentid | integer | по рекомендации от | Не обязательное поле. | |
18 | level | integer | уровень доступа пользователя | Не обязательное поле. | Уровни доступа: 0 - заблокирован 1 - клиент 2 - сотрудник 3 - администратор |
19 | commentadmin | string | комментарий администратора | Не обязательное поле. | |
20 | groupid | integer | группа пользователя | Не обязательное поле. | Идентификатор группы контактов в системе BOX |
21 | source | integer | источник пользователя | Не обязательное поле. | Идентификатор источника в системе BOX |
22 | pricelevel | string | уровень цен пользователя | Не обязательное поле. | Название цены, которую вы желаете установить пользователю |
23 | distribution | boolean | Подписан контакт на рассылку | Не обязательное поле. | |
24 | tags | string | теги | Не обязательное поле. | |
25 | namelast | string | фамилия пользователя | Не обязательное поле. | |
26 | namemiddle | string | отчество пользователя | Не обязательное поле. | |
27 | typesex | string | пол пользователя | Не обязательное поле. | По умолчанию тип пользователя - мужчина. Доступные типы пользователей: man - мужчина woman - женщина company - компания |
28 | company | string | компания пользователя | Не обязательное поле. | |
29 | code1c | string | code1c пользователя | Не обязательное поле. | id пользователя из вашей системы |
30 | companyid | integer | id компании пользователя | Не обязательное поле. | |
31 | companycode1c | integer | внешний код компании пользователя | Не обязательное поле. | |
32 | emails | string | email-ы пользователя (дополнительные) | Не обязательное поле. | Указывать через пробел (test@tset.ua dddd@ya.ru) |
33 | managerid | integer | id менеджера из OneBox | Не обязательное поле. | |
34 | managercode | string | code1c менеджера из OneBox | Не обязательное поле. | |
35 | phones | string | телефоны пользователя (дополнительные) | Не обязательное поле. | Указывать через пробел (380977777777 380500500550) без пробелов в самих телефонах |
36 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
37 | update | boolean | Обновлять контакта если он найден по контактным данным | Не обязательное поле. |
Пример:
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий | ||
---|---|---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |||
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API | ||
3 | supplierhash | string | Ключ поставщика | Не обязательное поле. | Доступен в карточке клиента, который является контактом поставщика. Доступен при наличии логина и пароля от системы и уровня доступа "клиент". Позволяет ограничить доступ к получению контактов согласно связи дополнительного поля контакта с ключем поставщика(см. настройки "Проверки и уникальность") или клиентов процессов, где данный поставщик является поставщиком продуктов процесса. |
||
4 | userid | integer | Индентификатор контакта в системе BOX | Или userid или code1c или userlogin или phone или email контакта обязательно |
Значения возвращаемых полей
contactTypesex - пол контакта (не определен, мужчина, женщина, компания), |
||
5 | code1c | string | Идентификатор контакта из вашей системы (из вашего магазина) | ||||
6 | phone | string | Телефон контакта | ||||
7 | string | Емейл контакта | |||||
8 | userlogin | string | Логин контакта | ||||
9 | showbonus | boolean | Отобразить бонусы контакта | Не обязательное поле. | При указании значения параметра 1 будет отображаться поле contactBonuses с бонусами контакта |
Пример:
http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&userid=666
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий | ||
---|---|---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |||
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API | ||
3 | supplierhash | string | Ключ поставщика | Не обязательное поле. | Доступен в карточке клиента, который является контактом поставщика. Доступен при наличии логина и пароля от системы и уровня доступа "клиент". Позволяет ограничить доступ к получению контактов согласно связи дополнительного поля контакта с ключем поставщика(см. настройки "Проверки и уникальность") или клиентов процессов, где данный поставщик является поставщиком продуктов процесса. |
||
4 | groupid | integer | id группы из которой вы хотите получить пользователей | Не обязательное поле. | |||
5 | udatefrom | datetime | дата обновления пользователя начиная с даты в формате Y-m-d H:i:s | Не обязательное поле. | |||
6 | udateto | datetime | дата обновления пользователя до даты в формате Y-m-d H:i:s | Не обязательное поле. | |||
7 | typesex | string | Тип контактов | Не обязательное поле. | Необходимо передавать ключ типов контактов (к примеру company) | ||
8 | custom_[ключ] | optional | Фильтрация по дополнительным полям контактов | Не обязательное поле. | |||
9 | part | integer | Часть товаров | Обязательное поле. |
API выдаёт в 1й части до 1000 контактов, чтобы получить следующие 1000 товаров передайте туда 2 (получается часть 2) и тд.
contactTypesex - пол контакта (не определен, мужчина, женщина, компания), Так же доступна фильтрация контактов по возвращаемым полям. |
||
10 | showbonus | boolean | Отобразить бонусы контакта | Не обязательное поле. | При указании значения параметра 1 будет отображаться поле contactBonuses с бонусами контакта |
Пример:
http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&part=2
и тд..
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
3 | userid | integer | Или userid или code1c контакта обязательно | Обязательное поле. | |
4 | code1c | string | Идентификатор контакта из вашей системы (из вашего магазина) | Не обязательное поле. | |
5 | userlogin | string | Логин контакта | Не обязательное поле. | |
6 | userpass | string | Пароль контакта | Не обязательное поле. | |
7 | name | string | имя пользователя | Не обязательное поле. | |
8 | string | email пользователя | Не обязательное поле. | ||
9 | emails | string | email-ы пользователя (дополнительные) | Не обязательное поле. | Указывать через пробел (test@tset.ua dddd@ya.ru) |
10 | phone | string | телефон пользователя | Не обязательное поле. | |
11 | phones | string | телефоны пользователя (дополнительные) | Не обязательное поле. | |
12 | address | string | полный адрес пользователя одной строкой (устаревший параметр) | Не обязательное поле. | |
13 | country | string | Страна | Не обязательное поле. | |
14 | region | string | Регион (область) | Не обязательное поле. | |
15 | district | string | Район | Не обязательное поле. | |
16 | city | string | Название населенного пункта | Не обязательное поле. | |
17 | street | string | Улица | Не обязательное поле. | |
18 | street_number | string | Номер дома | Не обязательное поле. | |
19 | apartment | string | Квартира | Не обязательное поле. | |
20 | bdate | date | день рождения пользователя | Не обязательное поле. | |
21 | groupid | integer | группа пользователя | Не обязательное поле. | Идентификатор группы контактов в системе BOX |
22 | namelast | string | фамилия пользователя | Не обязательное поле. | |
23 | namemiddle | string | отчество пользователя | Не обязательное поле. | |
24 | source | string | Источник пользователя | Не обязательное поле. | |
25 | typesex | string | пол пользователя | Не обязательное поле. | По умолчанию тип пользователя - мужчина. Доступные типы пользователей: man - мужчина woman - женщина company - компания |
26 | company | string | Компания | Не обязательное поле. | Если их несколько указываем через запятую |
27 | companyid | integer | id компании | Не обязательное поле. | |
28 | distribution | boolean | Подписан контакт на рассылку | Не обязательное поле. | |
29 | urls | string | веб-сайт контакта | Не обязательное поле. | |
30 | update | boolean | Обновлять ли контактные данные | Не обязательное поле. | Принимает параметр 1 или 0, по умолчанию 0. Если передать 1 то контактные данные (телефоны и email-ы) будут обновляться, в противном случае если передать 0 то будут дописыватся к сущесвующим |
31 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Пример:
http://myboxurl/api/contact-update/json/?login=LOGIN&password=PASSWORD&userid=666&email=test@tst.com
№ | Поле | Тип | Описание | Обязательное или нет | Коментарий |
---|---|---|---|---|---|
1 | login | string | Логин в системе BOX | Обязательное поле. | |
2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
3 | userid | integer | Идентификатор (ID OneBox) удаляемого контакта | Не обязательное поле. | |
4 | code1c | string | Идентификатор удаляемого контакта из вашей системы (из вашего магазина) | Не обязательное поле. |
Пример:
http://myboxurl/api/contact-delete/json/?login=LOGIN&password=PASSWORD&userid=666
№ | Статус | Сообщение | Описание сообщения |
1 | ok | userid | id добавленного/отредактированного юзера |
2 | fail | login_empty | Отсутствует логин |
3 | fail | password_empty | Отсутствует пароль |
4 | fail | Login or password not correct! | Неправильный логин или пароль |
5 | fail | Bad user level! | Низкий уровень пользователя, для выполнения данного действия(нужен level 2 и выше) |
6 | fail | name_empty | Имя отсутствует |
7 | fail | email or phone is empty | email или телефон отсутствуют |
8 | fail | Payment by id or code1c not found | Платеж с таким id или кодом уже существует |
9 | fail | dublicate by code1c | Контакт с таким кодом уже существует |
10 | fail | Not found contact | Контакт не найден |
11 | fail | User-object by code1c not found | Контакт с таким кодом не найден |
12 | fail | Phone is exists | Контакт с таким телефоном уже существует |
13 | fail | Email is exists | Контакт с таким email уже существует |