Redemption Methods

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

Accept

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:

en

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.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.zid.sa/v1v1/customers/loyalty-program/<<STORE_ID>>/point-redemption-methods?STORE_ID' \
--header 'Authorization: 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' \
--header 'Accept;' \
--header 'Accept-Language;' \
--header 'X-CUSTOMER-TOKEN;' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200OK

application/json

List of available redemption methods retrieved successfully.

Body

status

string

optional

Indicates the overall status of the API response.

point_redemption_methods

array [object {13}]

optional

A list of available methods for redeeming points, each represented as an object with detailed information.

id

string

optional

A unique identifier for the point redemption method.

Example:

d7d31391-dc3e-41f6-888b-ba189b28c732

external_id

string

optional

An external identifier associated with the point redemption method.

Example:

581

store_id

string

optional

The unique identifier of the store associated with this redemption method.

Example:

266fd313-f39a-4f43-82c5-6069651e32cc

name

string

optional

The name or label of the redemption method.

Example:

1

points_to_redeem

integer

optional

The number of points required to redeem this reward.

Example:

1

rule_type

string

optional

The type of rule applied to the redemption method, such as "fixed_rate_settings".

Example:

fixed_rate_settings

reward

object

optional

Details about the reward associated with the redemption method.

conditions

null

optional

Any conditions or restrictions applicable to the redemption method. Null indicates no specific conditions.

is_active

boolean

optional

Indicates whether the redemption method is currently active.

Default:

true

created_at

string

optional

The date and time when the redemption method was created, in ISO 8601 format.

Example:

2024-02-04T15:59:44.000000Z

updated_at

string

optional

The date and time when the redemption method was last updated, in ISO 8601 format.

Example:

2024-03-04T15:59:44.000000Z

deleted_at

null

optional

The date and time when the redemption method was deleted.

store

object

optional

Information about the store associated with the redemption method.

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.

Example

{
  "status": "string",
  "point_redemption_methods": [
    {
      "id": "d7d31391-dc3e-41f6-888b-ba189b28c732",
      "external_id": "581",
      "store_id": "266fd313-f39a-4f43-82c5-6069651e32cc",
      "name": "1",
      "points_to_redeem": 1,
      "rule_type": "fixed_rate_settings",
      "reward": {
        "discount_value": 1
      },
      "conditions": null,
      "is_active": true,
      "created_at": "2024-02-04T15:59:44.000000Z",
      "updated_at": "2024-03-04T15:59:44.000000Z",
      "deleted_at": null,
      "store": {
        "id": 550,
        "uuid": "266fd313-f39a-4f43-82c5-6069651e32cc",
        "name": "mohammed basideq",
        "url": "https://bandar-dev.zidtest.com/",
        "ssl": "https://bandar-dev.zidtest.com/",
        "currency": "SAR",
        "language_code": "ar",
        "quality_flag": 0,
        "has_new_products_service": 1,
        "has_new_shipping_module": true,
        "has_multi_product_inventory": true,
        "is_sent_to_odoo": true,
        "registration_fields": "{\\\"invoicing_buyer_id\\\": \\\"bda31228-791b-4aac-aa3e-7b35f66178c8\\\", \\\"started_business_before_registration\\\": \\\"0\\\"}",
        "has_current_business": null,
        "maintenance_mode": 0,
        "readiness_completed_at": "2021-09-28T12:57:35.000000Z",
        "mobile_verified_at": "2021-09-28T12:59:35.000000Z",
        "created_at": "2021-09-28T12:57:35.000000Z",
        "updated_at": "2021-09-28T12:58:35.000000Z",
        "es_subscription_id": "fefa2f16-d0bb-4b94-816a-73fd8358644d",
        "sv3_subscription_id": null,
        "deleted_at": null,
        "active_domains": [
          {
            "id": "002b2075-e662-4a55-b1b2-f385379b591d",
            "store_id": "266fd313-f39a-4f43-82c5-6069651e32cc",
            "domain": "bandar-dev.zidtest.com",
            "hash": "2593164025",
            "is_active": 1,
            "is_custom": 0,
            "expires_at": null,
            "created_at": "2022-04-05T13:54:53.000000Z",
            "updated_at": "2022-06-05T13:54:53.000000Z",
            "deleted_at": null,
            "dns_status": "connected",
            "zone_id": null,
            "hostname_id": null
          }
        ]
      }
    }
  ],
  "message": {
    "type": "string",
    "code": null,
    "name": null,
    "description": null
  }
}