Add Points Redemption Method

POSTv1/managers/loyalty-program/points-redemption

Creates a new redemption method (e.g., gift certificate) for a store's loyalty program

Request

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

required

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:

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Content-Type

enum<string>

required

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Allowed values:

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

Default:

application/json

config

object

optional

Contains the configuration settings for the point redemption method.

type

string

optional

Specifies the type of redemption rule.

Example:

fixed_rate_settings

discount

integer

optional

The value of the discount provided as a reward.

Example:

points

integer

optional

The number of points required to redeem the specified discount.

Example:

100

currency

string

optional

The currency in which the discount value is denominated.

Example:

SAR

{
  "config": {
    "type": "fixed_rate_settings",
    "discount": 10,
    "points": 100,
    "currency": "SAR"
  }
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

The redemption method is created successfully.

status

string

optional

Indicates the overall status of the API response.

points_redemption

object

optional

Contains details about the points redemption method that was added.

status

boolean

optional

Indicates whether the point redemption method was added successfully. In this case, it is true.

Default:

true

message

string

optional

A descriptive message confirming the successful addition of the points redemption method.

Example:

Point redemption method added successfully

redemptionRule

object

optional

Contains detailed information about the newly added point redemption rule.

message

object

optional

Contains additional information or messages related to the API response.

type

string

optional

Specifies the type of message.

code

string

optional

A code representing the specific message.

Example:

MSG_POPUP_OK

name

string

optional

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

Example:

"Points redemption"

description

string

optional

A detailed description of the message.

Example:

"Point redemption method added successfully"

{
  "status": "string",
  "points_redemption": {
    "status": true,
    "message": "Point redemption method added successfully",
    "redemptionRule": {
      "store_id": "266fd313-f39a-4f43-82c5-6069651e32cc",
      "external_id": "1120",
      "name": "100",
      "points_to_redeem": 100,
      "rule_type": "fixed_rate_settings",
      "reward": {
        "discount_value": 10
      },
      "is_active": true,
      "id": "bf1aeb4a-d85e-443d-80dc-f0ac43757605",
      "updated_at": "2024-07-31T11:10:50.000000Z",
      "created_at": "2024-07-31T11:10:50.000000Z"
    }
  },
  "message": {
    "type": "string",
    "code": "MSG_POPUP_OK",
    "name": "\"Points redemption\"",
    "description": "\"Point redemption method added successfully\""
  }
}

Last modified: 8 days ago