getOperations

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

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

[POST] …/v1/RetailCard/getOperations

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

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

Название Тип данных Обязательность Описание параметра
card_id Int64 Обязательный Id карты покупателя
promo_id Int64 Обязательный Id промоакции
type enum Необязательный Тип операции: Income (Входящий), Outcome (Исходящий)
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
sort_orders:column enum Необязательный Значение для сортировки: Default (без сортировки), Type (Тип операции), Date (Дата операции, Amount (Сумма, с которой зачисляется бонус), Value (Сумма бонуса), ExpiryDate (Дата истечения срока действия бонуса), LastUpdate (Дата последнего изменения)
sort_orders:direction enum Необязательный Порядок сортировки: Default (Без сортировки), ASC (По возрастанию), DESC (По убыванию)
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки

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

{
    "card_id":[1,2],
    "promo_id":[1,2],
    "type":[1,2],
    "start_date":1534153454,
    "end_date":1534157896,
    "sort_orders":
    {
        "column":'date',
        "direction":'desc'
    },
    "limit":20,
    "offset":3
}

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

Название Тип данных Обязательность Описание параметра
Result array of RetailCardOperation Обязательный Массив объектов RetailCardOperation

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

{
  "ok": true,
  "result": [
      {
          "uuid":"404cd163-83f0-11ea-9e81-b8975aece7d3",
          "type":2,
          "amount":0.000,
          "value":1000.000,
          "used_value":0.000,
          "is_payment":false,
          "date":1587487843,
          "exp_date":0,
          "description":null,
          "last_update":1587487843
      }
  ]
}