Zid Docs
Merchant APIApp APIThemes
Merchant APIApp APIThemes
Help Center
Slack
  1. 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
      • 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
        • Store Loyalty Status
        • 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
  1. Merchant API

Start Here 🚀

As a Zid Partner, you have the opportunity to create and offer apps and themes that help merchants scale their businesses. Whether you’re a developer, designer, or tech entrepreneur, we provide you with the ideal platform to bring your innovative solutions to a growing network of online stores.
Your Guide to Building Better
Explore the Merchant's help center to understand the dashboard features and configure your testing environment.

Join as a Zid Partner#

Your partnership journey begins by registering your partner account on Zid. Once registered, you will have access to the Partner Dashboard, where you can manage your apps and themes, track subscribed stores, monitor your monthly payouts and more!

Unlock Growth and Opportunities!#

Joining Zid as a partner opens the door to numerous benefits, including:
Expand Your Reach: Connect with a broad network of merchants eager to enhance their stores.
Unlock Revenue Streams: Generate income through app sales, theme designs, and additional services.
Comprehensive Support & Resources: Access a wealth of developer tools, technical assistance, and marketing resources to help you succeed.

Access Partner Dashboard

API Reference and Documentation#

Merchant APIs#

The Merchant API allows developers to interact directly with merchant stores, enabling them to perform various tasks such as updating store information, creating and managing products, set up webhooks for real-time data synchronization and more:
Need a specific endpoint that’s not listed? Click here to request and help us tailor our services to your needs!
Orders
Manage and track customer orders, including reversed orders and abandoned carts.
Products
Access and modify store's product catalog, including variants and product setting.
Inventories
Monitor and adjust stock levels for products across different locations.
Shipping
Set up and list shipping options for stores.
Marketing
Create and manage promotions, discounts, and other marketing tools.
Customers
List store customers, including profiles and addresses.
Store Settings
List general store settings, payment methods, and other preferences.
Countries and Cities
List geographic regions for shipping and other location-based settings.
Webhooks
Set up automated notifications for specific store events.
App Scripts
Integrate custom scripts to enhance store functionality and automation.

Theme Documentation#

Our Theme Documentation provides everything you need to build, customize, and manage themes that merchants can use to personalize their online stores. The documentation includes:
Templates
Files contains specific data that developers can utilize, offering the opportunity to create themes within Zid.
Settings Schema
Schemas that will enable you to create customizable, SEO-friendly, and user-friendly components for your theme.
Code Snippets
Files containing data and customization options that developers can utilize to support store features.

Access Help and Support#

Beyond the documentation, Zid offers several resources to support your development journey:
Partner Help Center
Access detailed how-to guides and troubleshooting tips
Changelog
Stay updated with the latest platform changes and improvements.
Partner Feedback
Share your feedback and ideas or vote on existing ones to help us improve.
In case you need additional assistance, reach out through:
Chat: Access the chat widget directly from your dashboard for instant help.
Email: Get direct support via email.
Slack: Join our community channel for collaboration.
Book a Meeting: Schedule time for technical troubleshooting or other issues.
Next
Overview to Zid Apps
Built with