API-метод поиска сделок

Запрос

POST: https://api.calltouch.ru/lead-service/v1/api/client-order/find

HTTP-заголовки:

Access-Token – API-ключ
SiteId – ID ЛК Calltouch

Тело запроса в формате JSON:

{
    "orderNumbers": ["ID сделки внутри CRM 1", "ID сделки внутри CRM 2", "ID сделки внутри CRM N"]
}

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

Это не метод выгрузки сделок, а именно поиска. Здесь важен только сам факт наличие у нас сделок, а не данные по ним. Метод понадобится для проверки на дубли перед созданием сделок. На вход подается только список ID сделки в CRM. В одном запросе можно указать не более 100 сделок.

Ответ

Процесс поиска запускается сразу же после отправки запроса, после чего сразу же возвращается и ответ, пример:

{
    "meta": [],
    "data": {
        "ordersFound": [
            "EgE5DZcfr3qWuh7T",
            "iG4xedu40llhsLHZ"
        ],
        "ordersNotFound": [
            "UdvPC9bBjjLnEJ9R"
        ]
    }
}

Если API-токен не указан, то поиск не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "message": "Ошибка доступа"
    }
}

Если API-токен указан не верно, то поиск не выполняется и выводится ошибка:

{
    "message": "Access token не найден"
}

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

Параметр	Формат	Описание
data.ordersNotFound	string	Список найденных ID среди указанных через запятую
data.ordersFound	string	Список ненайденных ID среди указанных через запятую

Если в запросе обнаруживаются ошибки валидации, то поиск не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "type": "validationError",
        "apiErrorData": null,
        "validationErrorData": {
            "violations": [
                {
                    "fieldPath": "orderNumbers[0]",
                    "message": "Тип значения должен быть string."
                }
            ]
        }
    }
}