Loyalty

Loyalty account and point movements

Get Total Loyalty Balance

get

Returns the user's total loyalty (points) balance.

Business Logic:

  • Aggregates balances from all loyalty accounts for the active session currency

  • Returns a single balance value (Decimal, 2 fractional digits)

  • Multi-currency supported: separate balance per currency

  • Filtered by session currency

Notes:

  • Only returns balance for the active session currency

  • If balance is 0: no account in this currency OR fully consumed

Authorizations
Header parameters
X-CookiestringRequired

Use X-Cookie header instead of Cookie header in "try out" section. Use Cookie header while testing in postman or other tools. Some commerce applications may support 'sesionid' instead of 'osessionid'.

Example: osessionid=abc123
Accept-Languagestring · enumOptional

Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr

Default: trExample: trPossible values:
Responses
chevron-right
200

Successful response

application/json
get
/loyalty-account-balance/

List Loyalty Transfers

get

Lists the user's loyalty point transfer history.

Business Logic:

  • Includes both point earnings and spendings

  • Each transfer: amount, transaction date, related order number, currency

  • Sorted newest first (-pk)

  • Supports pagination

  • Filtered by session currency

Transfer Types:

  • Positive values: Point earning (credit) – post-order accrual

  • Negative values: Point spending (debit) – usage during checkout

Related Data:

  • Each transfer is linked to a LoyaltyTransaction

  • Transaction contains an order number (order.number)

  • Transaction date (transaction.created_date) is also returned

Authorizations
Query parameters
pageinteger · min: 1Optional

Page number (starts from 1)

Default: 1Example: 1
page_sizeinteger · min: 1Optional

Number of records per page

Default: 10Example: 10
Header parameters
X-CookiestringRequired

Use X-Cookie header instead of Cookie header in "try out" section. Use Cookie header while testing in postman or other tools. Some commerce applications may support 'sesionid' instead of 'osessionid'.

Example: osessionid=abc123
Accept-Languagestring · enumOptional

Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr

Default: trExample: trPossible values:
Responses
chevron-right
200

Successful response

application/json
get
/loyalty/

Last updated

Was this helpful?