Покупатели
Апи для менеджеров магазина, позволяет создавать и редактировать покупателей
- /api/lite/customers/
- /api/lite/customers/{email}
- POST /api/lite/customers/
- DELETE /api/lite/customers/
- customers.enable=true
/api/lite/customers/
Запрос списка покупателей
api/lite/customers/
Метод возвращает список покупателей текущего аккаунта
Пейджинация
Для пейджинации используются параметры page и size: size - записей на странице, page - номер страницы.
Пример: api/lite/customers?page=0&size=10
Если параметры не переданы, то дефолтные значения page=0&size=10
Фильтрация
api/lite/customers?page=0&size=10&text=Ivan
Также, для отображение пейджинации следует анализировать параметр totalElements и totalPages, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть) и страниц.
Пример результата запроса:
{
"content": [
{
"id": "e63d94d8-258f-489a-00fe-b8b6025ce677",
"emailLogin": "ivan@test.com",
"firstName": "Ivan",
"lastName": null,
"middleName": null,
"fullName": "Ivan",
"phone": "",
"rawPhone": "+79995556677",
"alternativePhone": "",
"consentToNewsletter": true
},
{
"id": "9a5e8591-7ea7-adb6-34db-546f105fc11a",
"emailLogin": "yura@test.com",
"firstName": "Yura",
"lastName": "Dan",
"middleName": "Dan",
"fullName": "Dan Yura Dan",
"phone": "",
"rawPhone": "+7985858585",
"alternativePhone": "",
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Московская",
"area": null,
"city": "Красногорск",
"settlement": "Ангелово",
"street": "мкр МЖК Росинка",
"house": "74/1",
"block": "",
"building": "",
"flat": "1",
"fullAddress": "Московская обл, г Красногорск, село Ангелово, мкр МЖК Росинка, д 74/1, кв. 1",
"fullCity": null,
"rawData": null,
"zip": "143442",
"regionFias": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
"areaFias": null,
"cityFias": "63fcf18a-365e-451f-baee-8d09ac50b773",
"settlementFias": "2b627d06-2257-4c20-83b1-5efa10ef57b4"
},
"consentToNewsletter": false
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"offset": 0,
"pageNumber": 0,
"pageSize": 10,
"paged": true,
"unpaged": false
},
"last": true,
"totalElements": 2,
"totalPages": 1,
"size": 10,
"number": 0,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"first": true,
"numberOfElements": 2,
"empty": false
}
/api/lite/customers/{email}
Запрос данных покупателя
/api/lite/customers/{email}
- email - логин-почта пользователя
Метод возвращает информацию о текущем данном покупателе.
Пример: /api/lite/customers/test@test.com
Метод возвращает информацию о текущем покупателе.
Параметр | Тип / формат | Описание |
id |
string |
Идентификатор пользователя |
emailLogin |
string |
Почта пользователя - является логином |
firstName |
string |
Имя |
lastName | string | Фамилия |
middleName | string | Отчество |
fullName | string | Имя в формате ФИО |
phone | string | Отформатированный телефон |
rawPhone | string | Телефон |
alternativeRawPhome | string | Дополнительный телефон |
alternativePhone | string | Дополнительный отформатированный телефон |
address |
object |
Адрес пользователя |
Пример результата запроса:
{
"id": "9a5e8591-7ea7-adb6-34db-546f105fc11a",
"emailLogin": "ivan@test.com",
"firstName": "Ivan",
"lastName": "Ivanov",
"middleName": "Ivanovich",
"fullName": "Ivanov Ivan Ivanovich",
"phone": "",
"rawPhone": "+7985858585",
"alternativePhone": ""
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Московская",
"area": null,
"city": "Красногорск",
"settlement": "Ангелово",
"street": "мкр МЖК Росинка",
"house": "74/1",
"block": "",
"building": "",
"flat": "1",
"fullAddress": "Московская обл, г Красногорск, село Ангелово, мкр МЖК Росинка, д 74/1, кв. 1",
"fullCity": null,
"rawData": null,
"zip": "143442",
"regionFias": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
"areaFias": null,
"cityFias": "63fcf18a-365e-451f-baee-8d09ac50b773",
"settlementFias": "2b627d06-2257-4c20-83b1-5efa10ef57b4"
}
}
Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Не найден покупатель с указанным email test@test.com"
}
]
}
POST /api/lite/customers/
Редактировать информацию о покупателе
/api/lite/customers/
Производит редактирование выбранного покупателя или добавление нового, если покупатель не найден.
Пример запроса:
{
"emailLogin": "test@test.com",
"firstName": "Oleg",
"lastName": "Pushkin",
"middleName": "Ivanov"
"rawPhone": "+792556123456",
"rawAlternativePhone": "+85645545454"
}
Успех:
В случае успеха вернется обновленный покупатель:
{
"id": "9a5e8591-7ea7-adb6-34db-546f105fc11a",
"emailLogin": "ivan@test.com",
"rawPhone": "+7985858585",
"firstName": "Oleg",
"lastName": "Pushkin",
"middleName": "Ivanov"
"rawAlternativePhone": "+85645545454",
"fullName": "Pushkin Oleg Ivanov",
"phone": "",
"alternativePhone": ""
}
DELETE /api/lite/customers/
Удаление покупателя
/api/lite/customers/
Параметры:
- email
Метод удаляет выбранного покупателя
Пример: /api/lite/customers?email=test@test.com
Успех:
Вернет id удаленного покупателя
{
"success": true,
"id":"9a5e8591-7ea7-adb6-34db-546f105fc11a"
}
Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Не найден покупатель с указанным email test@test.com"
}
]
}
customers.enable=true
Данный параметр приложения отвечает за включение или отключение автоматического добавление(создание нового покупателя) при заказе.
- customers.enable=true
- customers.enable=false