Zid Docs

Cashback Rules

GETv1/customers/loyalty-program/<<STORE_ID>>point-cashback-rules

Retrieves information about cashback rules associated with a 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.

STORE_ID

string

optional

Unique Id of the store.

Example:

1377

Body Params text/plain

Request samples

Responses

OK(200)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

Cashback rules are retrieved successfully.

status

string

optional

Indicates the overall status of the API response.

point_cahsback_rules

array [object {10}]

optional

A list of rules that dictate how cashback points are rewarded in exchange for a certain amount spent.

string

optional

A unique identifier for this specific cashback rule.

Example:

b1e3ca5d-2a89-4993-89bf-0f31a4b70b00

external_id

string

optional

References the "pos," likely indicating a point-of-sale system.

Example:

pos

store_id

string

optional

Identifies the specific store where this rule is applicable.

Example:

3dfc16e6-ad19-4126-9c2a-5e4a7fb73051

points_rewarded

integer

optional

1 point is rewarded for every 1 unit of currency spent.

Example:

amount_to_spend

integer

optional

Specifies the amount that needs to be spent to earn points, in this case, 1 unit of currency.

Example:

available_to

null

optional

Not specified, meaning this rule does not restrict which customers it applies to.

is_active

boolean

optional

The rule is currently inactive.

Default:

false

created_at

string

optional

The date and time when this rule was created.

Example:

2023-12-28T10:32:13.000000Z

updated_at

string

optional

The last date and time when this rule was modified.

Example:

2024-08-11T10:59:24.000000Z

deleted_at

null

optional

The date and time when this rule was deleted.

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 message 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",
  "point_cahsback_rules": [
    {
      "id": "b1e3ca5d-2a89-4993-89bf-0f31a4b70b00",
      "external_id": "pos",
      "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
      "points_rewarded": 1,
      "amount_to_spend": 1,
      "available_to": null,
      "is_active": false,
      "created_at": "2023-12-28T10:32:13.000000Z",
      "updated_at": "2024-08-11T10:59:24.000000Z",
      "deleted_at": null
    }
  ],
  "message": {
    "type": "string",
    "code": null,
    "name": null,
    "description": null
  }
}

Last modified: 3 months ago