Loyalty Program Points per Order

Calculates the number of points awarded based on a specific order total for a particular store's loyalty program.

🔑Scopes

loyalty_program.read - Loyalty Program Read

curl --location --request GET 'https://api.zid.sa/v1v1/customers/loyalty-program/<<STORE_ID>>/get-points-per-order-total/1000?STORE_ID&AMOUNT' \ --header 'Accept;' \ --header 'Accept-Language;' \ --header 'Content-Type: text/plain' \ --data-raw ''

Request

Query Params

STORE_ID

string

optional

Unique identifier of the store.

AMOUNT

string

optional

Order total amount.

Header Params

string

optional

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Default:

application/json

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Responses

🟢200Points are awarded for the order amount calculated successfully.

application/json

Body

status

string

optional

Indicates the overall status of the API response.

points

integer

optional

The total number of points associated with the customer. In this example, the customer has 1000 points.

Example:

"100"

message

object

optional

Contains additional information or messages related to the API response. Since all fields within the message object are null, it indicates that there are no specific messages, errors, or additional details to convey.

type

string

optional

Specifies the type of message. Here, it is "object", indicating a standard message type. Since the value is null, it signifies no specific message type.

code

null

optional

A code representing any specific message or error. Here, it is null, indicating no code is present.

name

null

optional

A short, human-readable title or name for the message.

description

null

optional

A detailed description of the message.