Получение списка клиентов

Возвращает список клиентов магазина с пагинацией. По умолчанию список отсортирован по идентификатору клиента по возрастанию.

Чтобы забирать изменения, передайте параметр updated_from с сортировкой sort_by=updated_at&sort_direction=asc.

Request

GET

https://api.kit.yandex.net/v1/customers

Query parameters

Name	Description
agreement_for_promo	Type: boolean Фильтр по согласию клиента на получение рекламных материалов. Не передавайте параметр, чтобы получить всех клиентов.
page	Type: integer Номер страницы. Default: `1` Min value: `1`
per_page	Type: integer Количество элементов на странице. Default: `25` Min value: `1` Max value: `100`
sort_by	Type: string Поле для сортировки. Default: `customer_id` Enum: `customer_id`, `registered_at`, `updated_at`
sort_direction	Type: string Направление сортировки. Default: `asc` Enum: `asc`, `desc`
updated_from	Type: string<date-time> Самая ранняя дата и время обновления клиента включительно. Example: `2021-01-01T00:00:00Z`
updated_to	Type: string<date-time> Самая поздняя дата и время обновления клиента включительно. Example: `2021-01-01T00:00:00Z`

Responses

200 OK

Список клиентов.

Body

application/json

{
  "customers": [
    {
      "customer_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "first_name": "Иван",
      "last_name": "Иванов",
      "is_registered": true,
      "phone": "+79991234567",
      "email": "user@example.com",
      "registered_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-02T00:00:00Z",
      "created_at": "2019-12-31T00:00:00Z",
      "order_count": 10,
      "order_sum": "10000.00",
      "number": 10000,
      "note": "Клиент часто покупает товары в нашем магазине",
      "agreement_for_promo": true,
      "agreement_at": "2024-05-20T12:30:00Z",
      "birth_date": "2003-02-04"
    }
  ],
  "total_count": 0
}

Name

Description

customers

Type: Customer[]

Example

[
  {
    "customer_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "first_name": "Иван",
    "last_name": "Иванов",
    "is_registered": true,
    "phone": "+79991234567",
    "email": "user@example.com",
    "registered_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-02T00:00:00Z",
    "created_at": "2019-12-31T00:00:00Z",
    "order_count": 10,
    "order_sum": "10000.00",
    "number": 10000,
    "note": "Клиент часто покупает товары в нашем магазине",
    "agreement_for_promo": true,
    "agreement_at": "2024-05-20T12:30:00Z",
    "birth_date": "2003-02-04"
  }
]

total_count

Type: integer

Общее количество клиентов.

CustomerID

Идентификатор клиента.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

Customer

Name	Description
agreement_for_promo	Type: boolean Согласие клиента на получение рекламных материалов.
created_at	Type: string<date-time> Дата и время создания клиента в магазине. Может быть раньше `registered_at`. Example: `2019-12-31T00:00:00Z`
customer_id	Type: CustomerID Идентификатор клиента. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
first_name	Type: string Имя клиента. Example: `Иван`
is_registered	Type: boolean Зарегистрирован ли клиент.
last_name	Type: string Фамилия клиента. Example: `Иванов`
note	Type: string Примечание к клиенту. Example: `Клиент часто покупает товары в нашем магазине`
number	Type: integer Номер клиента.
order_count	Type: integer Количество завершенных заказов клиента.
order_sum	Type: string Сумма завершенных заказов клиента. Example: `10000.00`
phone	Type: string Телефон клиента. Example: `+79991234567`
registered_at	Type: string<date-time> Дата регистрации клиента. Example: `2020-01-01T00:00:00Z`
updated_at	Type: string<date-time> Дата и время последнего обновления клиента. Example: `2020-01-02T00:00:00Z`
agreement_at	Type: string<date-time> Дата и время получения последнего согласия на рекламные материалы. Отсутствует, если клиент никогда не давал согласия. Поле не обнуляется при отзыве согласия — актуальность согласия определяется полем `agreement_for_promo`. Example: `2024-05-20T12:30:00Z`
birth_date	Type: string<date> Дата рождения клиента. Example: `2003-02-04`
email	Type: string<email> Email клиента. Example: `user@example.com`

Example

{
  "customer_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "first_name": "Иван",
  "last_name": "Иванов",
  "is_registered": true,
  "phone": "+79991234567",
  "email": "user@example.com",
  "registered_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-02T00:00:00Z",
  "created_at": "2019-12-31T00:00:00Z",
  "order_count": 10,
  "order_sum": "10000.00",
  "number": 10000,
  "note": "Клиент часто покупает товары в нашем магазине",
  "agreement_for_promo": true,
  "agreement_at": "2024-05-20T12:30:00Z",
  "birth_date": "2003-02-04"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

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

Список ресурсов

Получение клиента по ID