Zid Docs

Customer Points

GETv1/customers/loyalty-program/<<STORE_ID>>/points

Retrieves the current point balance for a customer within a specific store's loyalty program.

Request

Query Params

STORE_ID

string

optional

Unique identifier of the store.

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

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

X-CUSTOMER-TOKEN

string

optional

The X-CUSTOMER-TOKEN is a unique identifier generated when a customer logs in through the customer-login API. This token acts as the standard authorization mechanism, allowing the system to recognize the logged-in customer and grant them access to appropriate resources.

Body Params text/plain

Request samples

Responses

OK(200)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

The current points balance is retrieved successfully.

status

string

optional

Indicates the overall status of the API response.

points

object

optional

The points section provides information about the customer's points balance, including both available and used points.

available_poitns

integer

optional

The number of points currently available for the customer to use. This value represents the points that can be redeemed or applied to purchases.

Example:

used_poitns

integer

optional

The total number of points the customer has already used or redeemed. This tracks how many points have been spent from the customer's balance.

Example:

message

object

optional

Contains detailed information about the message.

type

string

optional

Specifies the type of message.

code

null

optional

A specific code representing the type.

name

null

optional

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

description

null

optional

A detailed description of the message, providing more context.

{
  "status": "string",
  "points": {
    "available_poitns": 0,
    "used_poitns": 0
  },
  "message": {
    "type": "string",
    "code": null,
    "name": null,
    "description": null
  }
}

Last modified: 3 months ago