Zid Docs
  1. Marketing
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
      • 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
          • Customer Points
          • Loyalty Program Points per Order
          • Store Loyalty Status
          • Redemption Methods
          • Cashback Rules
          • Add Redemption to Cart
          • Remove Redemption from Cart
          • Info Page
          • Loyalty Program Activation
          • Loyalty Status
          • Set Points Expiration
          • Cashback Rule Method Update
          • Cashback Rule Method Update Status
          • Add Points Redemption Method
          • Update Points Redemption Method
          • Delete Points Redemption Method
          • Toggle Redemption Method Status
          • Show Loyalty Points Info for Specific Customer
          • Customer Profile
          • List Data
          • Customer Points History
          • Info Page - Managers
          • Update Info Page
          • Adjust Customer Points
      • 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
  • App API
    • 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
      • 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
  1. Marketing

Loyalty Program

Customer Wallet
GETv1/customers/loyalty-program/<<STORE_ID>>/wallet
Retrieves detailed information about a customer&#39;s loyalty wallet, including points balance, currency type, and tier level.
Customer Points
GETv1/customers/loyalty-program/<<STORE_ID>>/points
Retrieves the current point balance for a customer within a specific store&#39;s loyalty program.
Loyalty Program Points per Order
GETv1/customers/loyalty-program/<<STORE_ID>>/get-points-per-order-total/1000
Calculates the number of points awarded based on a specific order total for a particular store&#39;s loyalty program. loyalty_program.read - Loy...
Store Loyalty Status
GETv1/customers/loyalty-program/1/loyalty-status
Retrieves information about the overall status (active/inactive) and program name of a store&#39;s loyalty program. loyalty_program.read - Loyal...
Redemption Methods
GETv1/customers/loyalty-program/<<STORE_ID>>/point-redemption-methods
Retrieves a list of available redemption methods (e.g., gift certificates, discounts) associated with a store&#39;s loyalty program.
Cashback Rules
GETv1/customers/loyalty-program/<<STORE_ID>>point-cashback-rules
Retrieves information about cashback rules associated with a store&#39;s loyalty program.
Add Redemption to Cart
POSTv1/stores/<<STORE_ID>>/carts/loyalty-redemption-method/add
Allows adding a chosen redemption method to a customer&#39;s shopping cart.
Remove Redemption from Cart
POSTv1/stores/<<STORE_ID>>/carts/loyalty-redemption-method/remove
Allows removing a previously added redemption method from a customer&#39;s shopping cart .
Info Page
GETv1/stores/<<STORE_ID>>/loyalty-program-info
Retrieves information about the store&#39;s loyalty program info page content. loyalty_program.read - Loyalty Program Read
Loyalty Program Activation
POSTv1/managers/loyalty-program/activation
Activates a loyalty program for a store. loyalty_program.read_write - Loyalty Program Read &amp; Write
Loyalty Status
GETv1/managers/loyalty-program/loyalty-status
Retrieves information about the overall status (active/inactive) of a store&#39;s loyalty program. loyalty_program.read - Loyalty Program Read
Set Points Expiration
POSTv1/managers/loyalty-program/points-expiration
Sets the expiration period for loyalty points within a store&#39;s program. loyalty_program.read_write - Loyalty Program Read &amp; Write
Cashback Rule Method Update
POSTv1/managers/loyalty-program/points-collection/update
Updates the configuration of a cashback rule within a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &amp; Writ...
Cashback Rule Method Update Status
PUTv1/managers/loyalty-program/points-collection/update-status
Enables or disables a specific cashback rule method within a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &am...
Add Points Redemption Method
POSTv1/managers/loyalty-program/points-redemption
Creates a new redemption method (e.g., gift certificate) for a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &...
Update Points Redemption Method
POSTv1/managers/loyalty-program/points-redemption/update
Updates the details of an existing redemption method within a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &a...
Delete Points Redemption Method
POSTv1/managers/loyalty-program/points-redemption/delete
Deletes a specific redemption method from a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &amp; Write
Toggle Redemption Method Status
PUTv1/managers/loyalty-program/points-redemption/update-status
Enables or disables a specific redemption method within a store&#39;s loyalty program. loyalty_program.read_write - Loyalty Program Read &amp; ...
Show Loyalty Points Info for Specific Customer
GETv1/managers/loyalty-program/customers/details
Retrieves detailed information about a specific customer&#39;s loyalty points, including balance and transaction history. loyalty_program.read -...
Customer Profile
GETv1/managers/store/customers/5835
Retrieves detailed information about a specific customer, including their loyalty program data. loyalty_program.read - Loyalty Program Read
List Data
GETv1/managers/loyalty-program/list-data
Retrieves list data relevant to the loyalty program configuration. loyalty_program.read - Loyalty Program Read
Customer Points History
GETv1/managers/loyalty-program/points-history/5835
Retrieves the transaction history of a specific customer&#39;s loyalty points activity. loyalty_program.read - Loyalty Program Read
Info Page - Managers
GETv1/managers/store/loyalty-program-info
Retrieves information about the store&#39;s loyalty program info page content. loyalty_program.read - Loyalty Program Read
Update Info Page
PUTv1/managers/store/loyalty-program-info
Updates the content of the store&#39;s loyalty program info page. loyalty_program.read_write - Loyalty Program Read &amp; Write
Adjust Customer Points
POSTv1/managers/loyalty-program/customers/adjust-customer-points
Allows manual adjustments to a customer&#39;s loyalty points balance. loyalty_program.read_write - Loyalty Program Read &amp; Write
Previous
Retrieve all Bundle Offers
Next
Customer Wallet
Built with