Zid Docs
Merchant APIPayment APIAppsThemes
Merchant APIPayment APIAppsThemes
Help Center
Slack
  1. Loyalty Program
  • Start Here πŸš€
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
      • Get Order Credit Notes
      • Get Order by ID
      • List of Orders
    • Reverse Orders
      • Reverse Order Reasons
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Get Store Settings
        • Add gift card to the cart
        • Update Store Settings
        • Upload gift card designs
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
          GET
        • Store Loyalty Status
          GET
        • Info Page
          GET
        • Loyalty Program Activation
          POST
        • Loyalty Status
          GET
        • Set Points Expiration
          POST
        • Cashback Rule Method Update
          POST
        • Cashback Rule Method Update Status
          PUT
        • Add Points Redemption Method
          POST
        • Update Points Redemption Method
          POST
        • Delete Points Redemption Method
          POST
        • Toggle Redemption Method Status
          PUT
        • Show Loyalty Points Info for Specific Customer
          GET
        • Customer Profile
          GET
        • List Data
          GET
        • Customer Points History
          GET
        • Info Page - Managers
          GET
        • Update Info Page
          PUT
        • Adjust Customer Points
          POST
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • πŸ“„ User Roles and Permissions
      • Get Manager's Profile
      • Get VAT Settings
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. Loyalty Program

Toggle Redemption Method Status

PUT
https://api.zid.sa/v1/managers/loyalty-program/points-redemption/update-status
Loyalty Program
Enables or disables a specific redemption method within a store's loyalty program.
πŸ”‘Scopes
loyalty_program.read_write - Loyalty Program Read & Write

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
Accept
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:
en
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
Body Params application/json
redemptionRuleUuid
stringΒ 
optional
A unique identifier for the loyalty redemption rule that is being targeted by the request.
Example:
c5ed20de-fe99-40b8-9fee-36b05b1a8436
status
integerΒ 
optional
A flag indicating whether to activate (1) or deactivate (0) the specified loyalty redemption rule.
Example:
1
Example
{
    "redemptionRuleUuid": "c5ed20de-fe99-40b8-9fee-36b05b1a8436",
    "status": 1
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.zid.sa/v1/managers/loyalty-program/points-redemption/update-status' \
--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 'Content-Type: application/json' \
--data-raw '{
    "redemptionRuleUuid": "c5ed20de-fe99-40b8-9fee-36b05b1a8436",
    "status": 1
}'

Responses

🟒200OK
application/json
Redemption method status toggled successfully.
Body
status
stringΒ 
optional
Indicates the overall status of the API response.
redemption_rule
objectΒ 
optional
The redemption_rule section provides detailed information about a specific point redemption rule.
id
stringΒ 
optional
A unique identifier for the specific redemption rule. This ID is used to track and manage the rule within the system.
Example:
7ba3e0ac-0ca9-4eeb-9026-01ec09ea3f6a
external_id
stringΒ 
optional
An identifier used by external systems to track or reference the redemption rule.
Example:
15505
store_id
stringΒ 
optional
The unique identifier of the store where this redemption rule is applied.
Example:
8b1cf62d-d05c-4405-949d-5c1cdcc64987
name
stringΒ 
optional
The name or label given to this redemption rule.
Example:
35
points_to_redeem
integerΒ 
optional
The number of points required to redeem the associated reward. This value represents the cost in points for the customer to obtain the benefit.
Example:
35
rule_type
stringΒ 
optional
The type of rule that defines how the reward is calculated or applied.
Example:
percentage_discount_settings
reward
objectΒ 
optional
conditions
nullΒ 
optional
Any specific conditions or restrictions that apply to this redemption rule.
is_active
booleanΒ 
optional
A boolean value indicating whether this redemption rule is currently active. True means the rule is active and can be used by customers.
Default:
true
created_at
stringΒ 
optional
The timestamp indicating when the redemption rule was created.
Example:
2023-04-03T09:17:47.000000Z
updated_at
stringΒ 
optional
The timestamp indicating when the redemption rule was updated.
Example:
2023-08-03T09:17:47.000000Z
deleted_at
nullΒ 
optional
The timestamp indicating when the redemption rule was deleted.
message
objectΒ 
optional
Contains detailed information about the message.
type
stringΒ 
optional
Specifies the type of message.
code
stringΒ 
optional
A specific code representing the type.
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, providing more context.
Example:
Update point redemption method status
Example
{
    "status": "string",
    "redemption_rule": {
        "id": "7ba3e0ac-0ca9-4eeb-9026-01ec09ea3f6a",
        "external_id": "15505",
        "store_id": "8b1cf62d-d05c-4405-949d-5c1cdcc64987",
        "name": "35",
        "points_to_redeem": 35,
        "rule_type": "percentage_discount_settings",
        "reward": {
            "discount_value": 3
        },
        "conditions": null,
        "is_active": true,
        "created_at": "2023-04-03T09:17:47.000000Z",
        "updated_at": "2023-08-03T09:17:47.000000Z",
        "deleted_at": null
    },
    "message": {
        "type": "string",
        "code": "MSG_POPUP_OK",
        "name": "Points redemption",
        "description": "Update point redemption method status"
    }
}
🟠404Record Not Found
Previous
Delete Points Redemption Method
Next
Show Loyalty Points Info for Specific Customer
Built with