Список покупателей

Возвращает список покупателей.

Формат запроса

GET https://api.tickets.yandex.net/api/crm\
 ? action=crm.customer.list\
 & auth=<string>\
 & city_id=<number>\
 & [limit=<number>]\
 & [offset=<number>]

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

Query-параметр	Описание
action*	string Идентификатор запроса.
auth*	string Идентификатор внешней системы.
city_id*	number Идентификатор города.
limit	number Максимальное количество возвращаемых объектов. Выдается не больше 1000 покупателей.
offset	number Количество пропускаемых в ответе объектов, начиная с первого.

* Обязательный параметр

Формат ответа

JSON

{
  "status": string,
  "result": [
    [
      {
      "id": number,
      "name": string,
      "phone": string,
      "email": string,
      "is_subscripted": number,
      "orders": [
        array
      ]
    }
  ]
}

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

Параметр	Описание
status	string Статус выполнения запроса. Возможные значения: `0` — запрос выполнен; `1` — произошла ошибка.
result[]	[object] Результат выполнения запроса.
result[].id	number Идентификатор покупателя.
result[].name	string ФИО покупателя.
result[].phone	string Телефон покупателя.
result[].email	string Email покупателя.
result[].is_subscripted	number Согласен ли покупатель на получение рассылок. Возможные значения: `0` — не согласен; `1` — согласен.
result[].orders[]	array Массив идентификаторов заказов покупателя.

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

{
  "status": "0",
  "result": [
    [
      {
        "id": 621643,
        "name": "настя",
        "phone": "+79000000001",
        "email": "123@nomail.ru",
        "is_subscripted": 0,
        "orders": [
          "186079",
          "398613",
          "398615",
          "398617",
          "429953",
          "621644",
          "930738"
        ]
      }
    ],
    [
      {
        "id": 621645,
        "name": "ку",
        "phone": "",
        "email": "ку",
        "orders": [
          "621646"
        ]
      }
    ]
  ]            
}

Была ли статья полезна?

Информация о заказе

Список агентов