sale/customer/getReward - Equotix One API

This returns the list of rewards transactions for a specific customer in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

customer_id

integer

required

The customer ID to search for specifically.

filter_date_added

string

optional

Filter the list of transactions after the specified date.

page

integer

optional

Page number of the results.

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "customer_id": 0,
  "filter_date_added": "string",
  "page": 0,
  "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

required

Returns only if there is an error.

reward

integer

required

The total number of reward points available for the customer.

total

integer

required

The total number of results available.

rewards

array [object {3}]

required

The list of transactions.

reward

integer

required

The number of points added or subtracted.

description

string

required

The transaction description.

date_added

string

required

The date time the transaction was created.

Example

{
  "error": [
    "string"
  ],
  "reward": 0,
  "total": 0,
  "rewards": [
    {
      "reward": 0,
      "description": "string",
      "date_added": "string"
    }
  ]
}