[lightMode]

Customer Loyalty Points

GET/customers/loyalty/points

[updatedIn] 5 days ago

This endpoint allows you to fetch the history of a customer's loylty points that is assocaited with the store.

:::info
This endopint will work only if the store has Customer Loyalty application installed.
:::

`customers.read` - Customers Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

customer_id

string

required

The unique ID number of the customer. Get a list of Customer IDs from here

Example:

1257881496

Request samples

[api.label.responses]

OK(200)

Validation(422)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Loyalty Points) {8}]

required

name

string

required

Description or a reason of the loyalty points increase or decrese

points

integer

required

Amount of loyalty points for the customer

used_points

integer

required

Amount of used points for the customer

status

string

required

Status of the loyalty points

created_at

object (Date)

required

expiry_date

string

2029-02-16 14:59:03

required

Date and time of the expirey date

order_id

string | null

required

Order ID in case the loyalty points have been earned from an order

reference_id

string | null

required

Order reference ID in case the loyalty points have been earned from an order

pagination

object (Pagination)

required

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "name": "مخصصة",
      "points": 900,
      "used_points": 0,
      "status": "مؤكدة",
      "created_at": {
        "date": "2024-12-17 17:42:14.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "expiry_date": "2029-02-17 17:42:14",
      "order_id": 98787845454,
      "used_at": null,
      "notes": "reason text",
      "reference_id": 3215487
    },
    {
      "name": "مخصصة",
      "points": 900,
      "used_points": 0,
      "status": "مؤكدة",
      "created_at": {
        "date": "2024-12-17 17:15:47.000000",
        "timezone_type": 3,
        "timezone": "Asia/Riyadh"
      },
      "expiry_date": "2029-02-17 17:15:47",
      "order_id": null,
      "used_at": null,
      "notes": "sample note",
      "reference_id": null
    }
  ],
  "pagination": {
    "count": 30,
    "total": 39,
    "perPage": 30,
    "currentPage": 1,
    "totalPages": 2,
    "links": {
      "next": "http://api.salla.dev/admin/v2/customers/loyalty/points?customer_id=1227534533&page=2"
    }
  }
}

[updatedIn] 5 days ago