Zid Docs
  1. Loyalty Program
Zid Docs
  • Merchant API
    • 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
        • Order Notes
      • 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
          • List Product Reviews
        • 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
          • Change Review Status
          • Bulk Change all Review Statuses
          • Delete Review
          • Import Product Reviews
          • Reply to Review
          • Delete Reply
          • Update Reply to Review
        • 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
          • Customer Wallet
            GET
          • Customer Points
            GET
          • Loyalty Program Points per Order
            GET
          • Store Loyalty Status
            GET
          • Redemption Methods
            GET
          • Cashback Rules
            GET
          • Add Redemption to Cart
            POST
          • Remove Redemption from Cart
            POST
          • 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
          • List Data
            GET
          • Customer Points History
            GET
          • Info Page - Managers
            GET
          • Update Info Page
            PUT
          • Adjust Customer Points
            POST
      • Customers
        • Customer Profile
        • 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
  • Payment API
    • Overview
    • Merchant Activation
    • Payment
      • Overview
      • Embedded Payment
      • Gateway Error Codes
      • Direct Payment
      • Execute Payment Request
      • Get payment status
    • ApplePay
      • ApplePay Checkout
      • Register ApplePay Domain
      • Providing Merchant Validation
    • Refund
      • Request Refund
    • Webhooks
      • Overview
      • Link Merchant Event
      • Payment Paid Event
      • Refund Event
  • Apps
    • Create your First App
    • Embedded Apps
    • App Scripts
    • App Events
    • App Subscription
      • Get Subscription Details
      • Update Usage-Based Charges
  • Themes
    • 🚨 Important Update: Zid Themes
    • Adding Video URL Feature to Third-Party Themes
    • Landing Page Development
    • Getting Started with Zid Themes
      • Introduction to Theme Development
      • Manage your Themes
      • Building Themes in Zid
      • Theme File Structure
      • Twig Syntax and Features
      • Zid Theme Packager
    • Templates
      • Layout
      • Home Page
      • Products
      • Cart
      • Store Language and Currency
    • Settings Schema
      • Text
      • Number
      • Text-Area
      • Select
      • Radio Buttons
      • Checkbox
      • Range
      • Color
      • Image
      • Product
      • Category
      • List
      • Fieldset
    • Code Snippets
      • Apple Pay Quick Checkout
      • Custom CSS Injection
      • Displaying the Store's Business Center Logo
      • Customizing Copyright Text
      • Store's Main Navigation Menu
      • Customer Wishlist
      • Store Social Media
      • Products
        • Products Badges
        • Product Ratings
        • Remaining Product Stock
        • Sold Items Count
        • Product Filtration by Attributes
        • Grouped Products
        • Product Questions & Answers
        • Product Restock Notfication
      • SEO
        • Images alt text
        • Themes SEO Marketing Tags
      • Marketing
        • Metafields
        • Gift Feature
        • Loyalty Program
    • Zid Themes Library: API Integration
      • Products
      • Product Categories
      • Cart
      • Blog
      • Customer
      • Store Settings
    • Data Reference
      • Locals
      • Store
      • Cart
      • Product
      • Products List
      • Category
      • Categories List
      • Session
      • FAQs
      • Customer
      • Blogs
      • Page
      • Main Menu
      • Main Navigation Menu
      • Request
      • Orders
      • Addresses
      • Store Payment Methods
      • Store Shipping Methods
      • Store Banks
      • Asset URL
      • Header Meta Tags
      • Loyalty pogram Wallet
    • Themes CLI
      • CLI Authentication
      • Theme Create
      • Theme Package
      • Theme Update
      • Themes List
      • Theme Preview
  • MCP
    • Orders
    • Orders 1
  1. Loyalty Program

Redemption Methods

GET
https://api.zid.sa/v1v1/customers/loyalty-program/<<STORE_ID>>/point-redemption-methods
Retrieves a list of available redemption methods (e.g., gift certificates, discounts) associated with a store's loyalty program.
Request Request Example
Shell
JavaScript
Java
Swift
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 ''
Response Response 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
    }
}

Request

Query Params

Header Params

Responses

🟢200OK
application/json
List of available redemption methods retrieved successfully.
Body

Modified at 2024-10-22 09:11:48
Previous
Store Loyalty Status
Next
Cashback Rules
Built with