Loyalty | Home

get

This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available.

Authorizations

Query parameters

balancenumberOptional

Query parameter balance used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

currencystring · enumOptional

Query parameter currency used to filter results based on specific conditions.

Possible values:

debit_allowedbooleanOptional

Query parameter debit_allowed used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

numberstringOptional

Query parameter number used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

user_emailstringOptional

Query parameter user_email used to filter results based on specific conditions.

uuidstring · uuidOptional

Query parameter uuid used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/accounts/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "balance": "text",
      "created_date": "2025-06-27T08:04:15.241Z",
      "currency": "try",
      "debit_allowed": true,
      "id": 1,
      "modified_date": "2025-06-27T08:04:15.241Z",
      "number": "text",
      "user": 1,
      "user_email": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

This method returns details about a specific loyalty account, including its ID, currency, balance, and whether debit is allowed. It also includes the account number, UUID, creation and modification timestamps, and the associated user email if available. This endpoint retrieves a specific record by its unique identifier.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this loyalty account.

Responses

200

Successful response for status code 200.

application/json

404

Object not found.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/accounts/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "balance": "text",
  "created_date": "2025-06-27T08:04:15.241Z",
  "currency": "try",
  "debit_allowed": true,
  "id": 1,
  "modified_date": "2025-06-27T08:04:15.241Z",
  "number": "text",
  "user": 1,
  "user_email": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification.

Authorizations

Query parameters

amountnumberOptional

Query parameter amount used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

currencystringOptional

Query parameter currency used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

orderintegerOptional

Query parameter order used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

referencestringOptional

Query parameter reference used to filter results based on specific conditions.

remote_addrstringOptional

Query parameter remote_addr used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

user_emailstringOptional

Query parameter user_email used to filter results based on specific conditions.

uuidstring · uuidOptional

Query parameter uuid used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/transactions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "amount": "text",
      "created_date": "2025-06-27T08:04:15.241Z",
      "currency": "try",
      "id": 1,
      "modified_date": "2025-06-27T08:04:15.241Z",
      "order": 1,
      "reference": "text",
      "remote_addr": "text",
      "user": 1,
      "user_email": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

This method returns details about a specific loyalty transaction, including its ID, currency, amount, and reference number. It also includes the associated user email, order ID, user ID, remote address, and timestamps for creation and modification. This endpoint retrieves a specific record by its unique identifier.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this loyalty transaction.

Responses

200

Successful response for status code 200.

application/json

404

Object not found.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/transactions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "amount": "text",
  "created_date": "2025-06-27T08:04:15.241Z",
  "currency": "try",
  "id": 1,
  "modified_date": "2025-06-27T08:04:15.241Z",
  "order": 1,
  "reference": "text",
  "remote_addr": "text",
  "user": 1,
  "user_email": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification.

Authorizations

Query parameters

accountintegerOptional

Query parameter account used to filter results based on specific conditions.

amountnumberOptional

Query parameter amount used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

currencystringOptional

Query parameter currency used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

limitintegerOptional

Limits the number of results returned in the response.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

referencestringOptional

Query parameter reference used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

transactionintegerOptional

Query parameter transaction used to filter results based on specific conditions.

uuidstring · uuidOptional

Query parameter uuid used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/transfers/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "account": 1,
      "amount": "text",
      "created_date": "2025-06-27T08:04:15.241Z",
      "currency": "try",
      "id": 1,
      "modified_date": "2025-06-27T08:04:15.241Z",
      "reference": "text",
      "transaction": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

This method returns details about a specific loyalty transfer, including its ID, currency, amount, and reference number. It also includes the associated loyalty account ID, transaction ID, and timestamps for creation and modification. This endpoint retrieves a specific record by its unique identifier.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this loyalty transfer.

Responses

200

Successful response for status code 200.

application/json

404

Object not found.

application/json

get

GET /api/v1/remote/1/data-warehouse/loyalty/transfers/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "account": 1,
  "amount": "text",
  "created_date": "2025-06-27T08:04:15.241Z",
  "currency": "try",
  "id": 1,
  "modified_date": "2025-06-27T08:04:15.241Z",
  "reference": "text",
  "transaction": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}