Get

[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 Необязательный Смещение от начала выборки
SortOrders

Модель сортировки выходных параметров

Название Тип данных Описание
column Enum Значение для сортировки: <Id | 1> - Id карты покупателя, <GroupName | 2> - Группа карты покупателя, <CustomerFullName | 3> - ФИО владельца карты, <Promo | 4> - Промоакция, <Date | 5> - Дата создания карты, <ExpiryDate | 6> - Дата истечения срока действия карты
direction Enum Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

Пример запроса

{
    "ids":[1],
    "group_ids":[1],
    "customer_ids":[1],
    "promo_ids":[1],
    "barcode_value":"1234567890123",
    "sort_orders": [
        {
          "column": "Id",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":1,
    "offset":0
}

Выходные параметры

Название Тип данных Описание
result Array of RetailCard Массив карт покупателей
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 2,
            "group": {
                "id": 1,
                "parent_id": 0,
                "name": "карты 5",
                "child_count": 0,
                "last_update": 1655116137
            },
            "customer": {
                "id": 1,
                "region": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Samarkand",
                    "last_update": 1718702656
                },
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Покупатели",
                    "last_update": 1718202013,
                    "child_count": 0
                },
                "last_purchase": 0,
                "deleted_mark": false,
                "last_update": 1718711661,
                "first_name": "Megan",
                "last_name": "Williams",
                "middle_name": "Ann",
                "full_name": "Megan Ann Williams",
                "sex": "Female",
                "date_of_birth": "1964-12-22",
                "address": "Feliciashire",
                "main_phone": "998952087619",
                "phones": "+998952087619",
                "email": null,
                "refer_id": 1,
                "description": "Customer 4"
            },
            "barcode_value": "12345678",
            "barcode_type": {
                "id": 1,
                "name": "EAN13",
                "last_update": 1533817902
            },
            "promo": {
                "id": 1,
                "name": "Накопительная",
                "type": {
                    "id": 1,
                    "name": "Бонусная система",
                    "last_update": 1664715033
                },
                "active": false,
                "days": [
                    1
                ],
                "start_time": "00:00:00",
                "end_time": "23:59:00",
                "start_date": "2023-12-11",
                "end_date": "2024-01-11",
                "description": null,
                "sub_type": 0,
                "priority": 1,
                "last_update": 1719234620
            },
            "bonus_amount": 10000.1,
            "date": 1541331489,
            "unlimited": true,
            "last_purchase": 1541331489,
            "expiry_date": "2018-12-04",
            "enabled": true,
            "last_update": 1542217079
        }
    ],
    "next_offset": 0,
    "total": 2
}