Get a collection of status records
Get information about all status records on a customer account.
Customer statuses represent the customer's standing or tier within a loyalty program - for example, Silver, Gold, or Platinum. Each status record has a validity period; only one status can be active at a time. This endpoint returns all status records, including expired and inactive ones.
To assign a new status, use POST /customers/actions/set-status-record (enterprise interface only).
Path parameters
The unique ID of the customer.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Status validity. Just one status can be valid in the time. Possible values are: True for valid status / False for status not valid
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"status_records": [
{
"status_record_id": "87ac34ef46f3858a4ece61fb43",
"status_id": "86e05affc7a7abefcd513ab400",
"customer_id": "89ac83ca207a820c62c79bf03a",
"valid_from": "2019-05-29 00:00:00",
"valid_to": "2021-05-28 23:59:59",
"purchase_conditions": {
"keep_status_turnover": [
{
"currency_id": "86e05affc7a7abefcd513ab400",
"value": 1500
}
],
"next_status_turnover": [
{
"currency_id": "86e05affc7a7abefcd513ab400",
"value": 1500
}
],
"keep_status_points": 300,
"next_status_points": 1500,
"next_status_id": "83d1d11ea3884a5d33253fe214"
},
"last_change": "2020-08-06 10:31:09",
"state": 1
}
],
"total_items": 1
}
}