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

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...
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
Loyalty Program Points per Order
Built with