Store Loyalty Status

Retrieves information about the overall status (active/inactive) and program name of a store's loyalty program.

🔑Scopes

loyalty_program.read - Loyalty Program Read

curl --location --request GET 'https://api.zid.sa/v1v1/customers/loyalty-program/1/loyalty-status?STORE_ID' \ --header 'Accept;' \ --header 'Accept-Language;' \ --header 'Content-Type: text/plain' \ --data-raw ''

Request

Query Params

STORE_ID

string

optional

Unique identifier of the store.

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:

Content-Type

string

optional

Type of the content.

Default:

application/json

Responses

🟢200Store loyalty program status retrieved successfully.

application/json

Body

status

string

optional

Indicates the overall status of the API response.

loyalty_status

boolean

optional

Indicates whether the customer is currently enrolled in the loyalty program. In this example, the value is true, meaning the customer is part of the loyalty program.

Default:

true

message

object

optional

Contains additional information or messages related to the API response.

type

string

optional

Specifies the type of message.

code

null

optional

A code representing any specific message or error.

name

null

optional

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

description

null

optional

A detailed description of the message.