GetOperations

[POST] .../v1/retailcard/getoperations

Returns information about customer card operations. Use this method to retrieve performed bonus operations for a retail customer card, such as bonus accruals, withdrawals and payment-linked operations. The request supports filters by operation UUIDs or by card_id and promo_id, plus type, start_date, end_date, sort_orders, limit and offset and returns result with next_offset and total. The method checks the current request user and requires customer card operation access permission; missing body, missing card_id or promo_id when UUIDs are not provided, denied permission, invalid filters or sort_orders and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return.
offset Int32 Optional Offset from the beginning of the result set.
sort_orders Array of RetailCardOperationColumn Optional Output data sorting.

Filterable Fields

Field Type Description
card_id int Customer card ID. Required with promo_id when uuids are omitted.
end_date int Period end date as Unix time in seconds.
promo_id int Promotion ID. Required with card_id when uuids are omitted.
start_date int Period start date as Unix time in seconds.
type string Operation type: Income - incoming, Outcome - outgoing.
uuids string Customer card operation UUIDs. Required when card_id and promo_id are omitted.

Sortable Fields

Field
amount
date
exp_date
last_update
type
value

Request Example

{
  "filters": [
    {
      "Field": "card_id",
      "Operator": "Equal",
      "Value": "string"
    }
  ],
  "limit": 1,
  "offset": 1,
  "sort_orders": [
    {
      "column": "type",
      "direction": "ASC"
    }
  ]
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of RetailCardOperation Result array.
total Int64 Total number of result items.

Response Example

{
  "next_offset": 1,
  "ok": true,
  "result": [
    {
      "amount": 1.0,
      "card_id": 1,
      "date": 1,
      "description": "string",
      "exp_date": 1,
      "is_payment": true,
      "last_update": 1,
      "type": "Income",
      "used_value": 1.0,
      "uuid": "00000000-0000-0000-0000-000000000000",
      "value": 1.0
    }
  ],
  "total": 1
}