LoyaltyTransactions

Retrieve a loyalty transaction

get

Retrieve detailed information for a specific loyalty transaction.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed information about the loyalty transaction.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/loyalty_transactions/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 100.5,
  "order": 1,
  "user_email": "[e-mail]",
  "transaction_type": "purchase",
  "customer": {
    "pk": 123,
    "email": "[e-mail]",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "[phone]",
    "is_active": true,
    "channel_code": "CH123",
    "erp_code": "ERP456",
    "attributes": {
      "logged_ip": "127.0.0.1",
      "register_client_type": "default"
    },
    "attribute_kwargs": {},
    "localized_attributes": {},
    "localized_attribute_kwargs": {},
    "extra_field": {
      "key1": "value1",
      "key2": 100
    },
    "email_allowed": true,
    "sms_allowed": false,
    "call_allowed": true,
    "date_joined": "2023-01-15T10:30:00Z",
    "gender": "female",
    "user_type": "guest",
    "date_of_birth": "1985-08-25",
    "channel": 5
  },
  "customer_email": "[e-mail]",
  "raw_request": "{...}",
  "raw_response": "{...}",
  "reference": "INV123456",
  "remote_addr": "192.168.1.1",
  "created_date": "2025-05-22T10:27:32.629Z",
  "modified_date": "2025-05-22T10:27:32.629Z"
}

Retrieve list of loyalty transactions

get

Retrieve a paginated list of all loyalty transactions.

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

transaction_typestring · enumOptional

Filter by transaction type.

Example: purchasePossible values:

ordernumberOptional

Filter by order ID.

Example: 123

user_emailstringOptional

Filter by user email.

Example: [e-mail]

customer_emailstring · emailOptional

Customer's email (case-insensitive)

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

referencestringOptional

Filter by reference.

Example: INV123456

Responses

200

A paginated list of loyalty transactions.

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/loyalty_transactions/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-05-22T10:27:32.629Z",
    "modified_date": "2025-05-22T10:27:32.629Z"
  }
]