API reference · CashBack

Get Marketplace Total Cashback Balance

Method: GET
Route: /loyaltyProgram/total
Base URL: https://ws.autorei.net
Token: Requires Bearer token

Opens this request in the public API documentation, the official source of the reference.

Description

Returns the cashback balance of your store, summed by type and by status. It is the consolidated view: one number per status, with no detail per customer or per order.

Response · 200

Two objects, credit and debit. In each one, the key is the status and the value is the total in that status — there are no fixed fields: only a status that has a balance appears. A store with no debit returns "debit": {}.

Field	Type	Description
`credit`	object	Cashback that customers earned, by status.
`debit`	object	Cashback that customers spent, by status.

Possible statuses in the keys:

Status	Where it appears	Meaning
`TO_RELEASE`	`credit`	Granted, still in the waiting period — the customer cannot use it.
`RELEASED`	`credit`	Released for use.
`CANCELLED`	`credit` · `debit`	Cancelled.
`INVALID_EXPIRED`	`credit`	Credit that expired without being used.
`IN_USE`	`debit`	Reserved in an open cart.
`USED`	`debit`	Actually consumed in a purchase.
`EXPIRED`	`debit`	Balance debit that expired.

The values are strings, not numbers — two decimal places and a period as the separator ("220971.17"). Convert before summing.

Errors

Code	When
400	`{"status":"BAD_REQUEST","message":"no record found"}` — the store has no cashback record at all. It is the response for a store with no loyalty program or no activity, not an error in your request.
401	Token missing, malformed or expired.

Example request

curl --request GET 'https://ws.autorei.net/loyaltyProgram/total' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — consolidated store balance

{
  "credit": {
    "TO_RELEASE": "1284.36",
    "RELEASED": "7350.09",
    "CANCELLED": "118.24",
    "INVALID_EXPIRED": "942.71"
  },
  "debit": {
    "IN_USE": "260.50",
    "USED": "4810.62",
    "EXPIRED": "331.08"
  }
}

Used in

Use casesB2B marketplace: the typical path through the API

GET List Aggregated Cashback Balance by Customer /loyaltyProgram/listCustomersTotal
GET Get Customer Cashback History /loyaltyProgram/customerReport/:document
POST Grant Cashback for External Order /loyaltyProgram/earnRewardExternal
PUT Update External Order Cashback /loyaltyProgram/earnRewardExternal

← See the group: CashBack

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.