Skip to main content

Loyalty

Get Loyalty Points and Credits​

The "Get Loyalty Points and Credits" API allows users to easily access details about their loyalty points and credits within the platform's rewards program. By using this API, users can conveniently check their balances and make informed decisions about redeeming points and credits for rewards.

  • Endpoint: api/customer/profile/loyalty_points

  • Http Method: GET

info

Before implementing the "Get Loyalty Points and Credits" API, it's important to check the 'LOYALTY_PROVIDER' key in the configuration. If the key is not null, it indicates that the loyalty program is active and running. :::

  • Success Response:
KeyTypeDescription
pointsIntegerThe number of loyalty points the customer has.
creditsIntegerThe number of loyalty credits the customer has.
{
    "code": 200,
    "message": "Success",
    "data": {
        "points": 0,
        "credits": 0
    },
    "meta": []
}
info

Check the following section to learn more about the Get Loyalty Points and Credits API Reference

Get Point History​

The "Get Point History" API allows users to retrieve a list of their loyalty point transactions. This is useful for customers who want to track their point balances and understand how they earned or spent their points.

  • Endpoint: api/customer/profile/loyalty_points/history

  • Http Method: GET

  • Success Response:

{
    "code": 200,
    "message": "Success",
    "data": {
        "earned": [],
        "used": [],
        "expired": []
    },
    "meta": []
}