Методы для работы с покупателями. Покупателя можно создать отдельно или сразу при создании заказа, передав его данные в заказе (см. статью Заказы).
Все адреса указаны относительно базового https://api.controlata.ru/connect/v1/. Формат запросов и авторизация описаны в статье Обзор API.
Поля покупателя
| Поле | Тип | Описание |
|---|---|---|
| name | string | Название компании или имя человека |
| type | int | Тип покупателя: 1 юридическое лицо, 2 индивидуальный предприниматель, 3 физическое лицо. По умолчанию 3 |
| string | Электронная почта | |
| phone | string | Телефон |
| address_legal | string | Юридический адрес |
| address_real | string | Адрес доставки |
| inn | string | ИНН |
| kpp | string | КПП |
| ogrn | string | ОГРН |
| agreement | string | Договор |
| manager_name | string | Руководитель |
| manager_post | string | Должность руководителя |
| notes | string | Заметки |
Создание покупателя
POST customers/add.php
Обязательное поле: name. Остальные поля из таблицы выше необязательные.
Пример запроса:
{
"name": "ООО Ромашка",
"type": 1,
"email": "romashka@example.com",
"phone": "+7 (495) 123-45-67",
"inn": "1234567890"
}
Пример ответа:
{
"success": true,
"customer_id": 123
}
Редактирование покупателя
POST customers/edit.php
Обязательные поля: customer_id и name. Остальные поля из таблицы выше необязательные.
Важно: метод перезаписывает покупателя целиком. Поле, которое не передано в запросе, станет пустым, а type станет равен 3 (физическое лицо). Чтобы изменить одно поле, получите покупателя методом customers/get_entry.php, измените нужное поле и отправьте все поля обратно.
Пример ответа:
{
"success": true
}
Удаление покупателя
POST customers/delete.php
Обязательное поле: customer_id.
Покупатель пропадает из списка покупателей, его файлы удаляются. Заказы покупателя остаются в системе.
Пример ответа:
{
"success": true
}
Получение списка покупателей
POST customers/get_list.php
Параметров нет. Метод возвращает всех покупателей компании, отсортированных по названию, без постраничной разбивки.
Пример ответа:
{
"success": true,
"customers": [
{
"id": "123",
"type": "1",
"name": "ООО Ромашка",
"email": "romashka@example.com",
"phone": "+7 (495) 123-45-67",
"address_legal": "",
"address_real": "",
"inn": "1234567890",
"kpp": "",
"ogrn": "",
"agreement": "",
"manager_name": "",
"manager_post": "",
"notes": ""
}
]
}
Получение данных покупателя
POST customers/get_entry.php
Обязательное поле: customer_id.
Пример ответа:
{
"success": true,
"customer": {
"id": "123",
"type": "1",
"name": "ООО Ромашка",
"email": "romashka@example.com",
"phone": "+7 (495) 123-45-67",
"address_legal": "",
"address_real": "",
"inn": "1234567890",
"kpp": "",
"ogrn": "",
"agreement": "",
"manager_name": "",
"manager_post": "",
"notes": ""
}
}
Ошибки
| Ошибка | Причина |
|---|---|
| No name in input | Не передано обязательное поле (вместо name будет имя поля) |
| Customer not found or access denied | Покупатель с таким ID не найден или удален |