API web-to-print TCSДокументация для разработчиков
Главная / Клиенты

Поиск по клиентам

Возвращает клиентов с контактами, последним заказом и назначенным менеджером.

Ссылка на API

https://your_site/api/client/search

Параметры запроса

Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.

ПолеТипОбязательноеОписание
keyStringДаСекретный API-ключ, выданный для сайта.
dataObjectДаКонтейнер параметров конкретного метода.
data.dateRegisteredFromstringНетstring, необязательный
data.dateRegisteredTostringНетstring, необязательный.

Пример запроса

POST /api/client/search
Content-Type: application/json

{
    "key": "ваш-api-ключ",
    "data": []
}

Параметры ответа

ПолеТипОбязательноеОписание
successBooleanДаtrue при успешном JSON-ответе; false при ошибке.
errorArray / ObjectДаПустой массив либо объект ошибки.
error.codeIntegerНетКод ошибки.
error.messageStringНетТекст ошибки.
data[]Array<Object>ДаСписок клиентов.
data[].idIntegerДаID клиента.
data[].nameStringНетМожет отсутствовать. Имя.
data[].surnameStringНетМожет отсутствовать. Фамилия.
data[].patronymicStringНетМожет отсутствовать. Отчество.
data[].emailStringНетМожет отсутствовать. E-mail.
data[].phoneStringНетМожет отсутствовать. Телефон.
data[].dateRegisteredStringДаДата регистрации.
data[].lastOrderDateStringНетМожет отсутствовать. Дата последнего заказа.
data[].managerObjectНетМожет отсутствовать. id, name, surname, fullName, email, phone.

Пример успешного ответа

{
    "success": true,
    "error": [],
    "data": [
        "..."
    ]
}
Ошибки: API может вернуть коды 1 - авторизация, 2 - данные не найдены, 3 - сохранение, 4 - недостаточно данных, 5 - неверный формат, 6 - валидация, 7 - доступ, 8 - не указан менеджер.