[POST] …/v1/RetailCard/Get
Возвращает информацию о карте покупателя.
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id карт покупателей |
group_ids | array of int64 | Необязательный | Массив id групп карту покупателей |
customer_ids | array of int64 | Необязательный | Массив id покупателей |
promo_ids | array of int64 | Необязательный | Массив id программ лояльности |
barcode_value | string | Необязательный | Штрих-код карты покупателя |
sort_orders | array of SortOrders | Необязательный | Сортировка выходных данных |
search | string | Необязательный | Строка данных для поиска карты покупателя по номеру телефона или ФИО |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id карты покупателя), GroupName (Группа карты покупателя), CustomerFullName (ФИО владельца карты), Promo (Промоакция), Date (Дата создания карты), ExpiryDate (Дата истечения срока действия карты) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,2],
"group_ids":[1,2],
"customer_ids":[1,2],
"sort_orders":
[
{
"column":"date",
"direction":"desc"
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
Result | array of RetailCard | Массив карт покупателей |
Пример ответа
{
"ok": true,
"result": [
{
"id": 2,
"group": {
"id": 1,
"parent_id": 0,
"name": "Бонусные карты",
"last_update": 1540023261
},
"customer": {
"id": 2,
"group": {
"id": 1,
"parent_id": 0,
"name": "root",
"last_update": 1539688864
},
"deleted_mark": false,
"last_update": 1541331477,
"first_name": "Василий",
"last_name": "Васильев",
"middle_name": "Василевич",
"sex": 0,
"document_name": null,
"document_code": null,
"date_of_birth": "2000-01-01",
"address": null,
"main_phone": null,
"phones": null,
"refer_id": 1
},
"barcode_value": "12345678",
"barcode_type": {
"id": 2,
"name": "EAN8",
"last_update": 1533817902
},
"promo": {
"id": 1,
"name": "Накопление баллов123",
"type": {
"id": 1,
"name": "Накопление баллов",
"last_update": 1541756840
},
"active": false,
"days": [ 1 ],
"start_time": "00:00:00",
"end_time": "23:59:00",
"start_date": "2012-11-20T00:00:00",
"end_date": "2012-12-20T00:00:00",
"description": null,
"last_update": 1542012524
},
"bonus_amount":10000,
"date": 1541331489,
"unlimited": true,
"expiry_date": "2018-12-04",
"enabled": true,
"last_update": 1542217079
}
]
}