GetOperations

RetailCardOperation

Модель, описывающая информацию об операциях на карте покупателя.

Название Тип данных Описание
uuid String UUID операции по карте
type Enum Тип операции: Income (Входящий), Outcome (Исходящий)
amount Decimal Сумма, с которой зачисляется бонус
value Decimal Сумма бонуса
used_value Decimal Использованная сумма бонуса
is_payment Bool Метка о том, что операция является платежом
date Int64 Дата операции в формате unix time в секундах
exp_date Int64 Дата истечения срока действия бонуса в формате unix time в секундах
description String Дополнительное описание
last_update Int64 Дата последнего изменения записи в формате unix time в секундах

[POST] …/v1/RetailCard/GetOperations

Возвращает информацию об операциях на карте покупателя.

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

Название Тип данных Обязательность Описание
card_id Int64 Обязательный Id карты покупателя
promo_id Int64 Обязательный Id промоакции
type enum Необязательный Тип операции: <Income | 1> - Входящий, <Outcome | 2> - Исходящий
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
SortOrders SortOrders Необязательный Сортировка выходных данных
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки

SortOrders

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Default | 0> - без сортировки, <Type | 1> - Тип операции, <Date | 2> - Дата операции, <Amount | 3> - Сумма, с которой зачисляется бонус, <Value | 4> - Сумма бонуса, <ExpiryDate | 5> - Дата истечения срока действия бонуса, <LastUpdate | 6> - Дата изменения
direction Enum Необязательный Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "card_id":1,
    "promo_id":1,
    "type":"Income",
    "start_date":1534153454,
    "end_date":1534157896,
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "limit":1,
    "offset":0
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "uuid": "404cd163-83f0-11ea-9e81-b8975aece7d3",
            "type": 1,
            "amount": 10000.1,
            "value": 1000.1,
            "used_value": 100.1,
            "is_payment": false,
            "date": 1587487843,
            "exp_date": 1534157896,
            "description": "example",
            "last_update": 1587487843
        }
    ],
    "next_offset": 1,
    "total": 1
}