Массовый поиск клиентов по атрибуту

Метод ищет сразу группу клиентов по списку идентификаторов и возвращает их профили. Удобен для сверки базы с внешней CRM: вместо запроса на каждого клиента отправляется один список.

text

POST https://api.nce.naumen.ru/crm/search/bulk

Параметры

Параметр	Тип	Обязателен?	Описание
shop_id	String	Да	API-ключ магазина
shop_secret	String	Да	Секретный ключ магазина
by	String	Да	Тип идентификатора — см. таблицу ниже
ids	Array	Да	Массив идентификаторов

Поддерживаемые идентификаторы

Идентификатор	Описание	Ограничения
loyalty_id	Номер карты лояльности	Нет
birthday	Дата рождения	Формат `YYYY-MM-DD`. Обрабатываются только 5 корректных дат, остальные пропускаются

Также поиск возможен по email и phone.

Запрос

bash

curl -i -X POST -H "Content-Type: application/json" \
  --data-binary "@data.json" \
  https://api.nce.naumen.ru/crm/search/bulk

# data.json
{
  "shop_id": "1234567890",
  "shop_secret": "0987654321",
  "by": "loyalty_id",
  "ids": ["L01", "L02"]
}

Ответ

json

[
  {
    "email": "email@example.com",
    "external_id": "1",
    "phone": "11111111111",
    "first_name": null,
    "last_name": null,
    "gender": null,
    "age": null,
    "birthday": null,
    "location": null,
    "email_bulk": true,
    "email_chain": true,
    "email_transactional": true,
    "web_push": true,
    "mobile_push": null,
    "sms_bulk": null,
    "sms_chain": null,
    "sms_transactional": null,
    "loyalty_id": "L01",
    "loyalty_location": null,
    "loyalty_status": null,
    "loyalty_bonuses": 300,
    "loyalty_bonuses_to_next_level": null,
    "created_date": null,
    "device": null
  },
  {
    "email": "email2@example.com",
    "external_id": "1",
    "phone": null,
    "first_name": "Thomas",
    "last_name": "Anderson",
    "gender": "m",
    "age": null,
    "birthday": "1971-09-11",
    "location": null,
    "email_bulk": true,
    "email_chain": true,
    "email_transactional": true,
    "web_push": true,
    "mobile_push": null,
    "sms_bulk": null,
    "sms_chain": null,
    "sms_transactional": null,
    "loyalty_id": "L02",
    "loyalty_location": null,
    "loyalty_status": null,
    "loyalty_bonuses": 0,
    "loyalty_bonuses_to_next_level": null,
    "created_date": null,
    "device": null
  }
]

Метод доступен только по REST — в SDK он не реализован.

Смотрите также

Получение профиля клиента

Массовый поиск клиентов по атрибуту ​

Параметры ​

Поддерживаемые идентификаторы ​

Запрос ​