Zid Docs
Apps
Themes
Payments
Apps
Themes
Payments
Changelog
Partner Login
Merchant APIs
Copy Page
🗂️ Overview
🚀 Start Here
Create your First App
Responses
Rate Limiting
Authorization
Embedded Apps
StoreFront Events
Zid MUI
Zid SDKs
Our custom MCP server
Merchant APIs
Account
Me
Me
Profile
Store
Store
Branding
Localization
Social
Operations
Business
Upload Logo Image
Delete Logo Image
Upload Icon Image
Delete Icon Image
Upload Cover Image
Delete Cover Image
Orders
Validate Order Request
Create Order
Change Order Status
Add Order Comment
View Order
List Orders
List Custom Order Statuses
List Order Credit Notes
Reverse Orders
Create Reverse Orders
Create Reverse Orders Waybill
Add Reverse Order Reasons
List Reverse Reasons
Calculate Reverse Totals
Create refund for reverse order
Upload bank transfer receipt
Update return products
Order Details – View for Return
Abandoned Carts
List Carts
View Cart
Products
Managing Products
Create Product Types
Create Product
List Products
View Product
List Product Settings
Update Product
Bulk Update Products
Delete Product
Digital Vouchers
List Vouchers
Order Vouchers
Create Voucher
Import Vouchers
Export Vouchers
Update Voucher
Remove Voucher
Product Categories
List Categories
View Category
Create Category
Create Subcategory
Update Category
Assign Product to Category
Bulk Assign Products to Category
Publish Category
Detach Category from All Products
Remove Product from Category
Product Badge
List Badges
Product Attributes
List Attributes
View Attribute
Create Attribute
Update Attribute
Delete Attribute
Product Attribute Presets
List Presets
Create Preset
Update Preset
Delete Preset
Product Variants
Create Variants
Create Custom Option
Update Custom Option
Delete Custom Option Field
Create Custom Input Field
Update Custom Input Field
Delete Custom Input Field
Product Sorting
Set Manual Product Order
Reset Manual Product Order
Product Images
List Images
Upload Image
Update Image Order
Delete Image
Product Availability Notifications
Notification Stats
Noticiation Settings
List Notifications
Create Notification
Update Settings
Send Notification Email
Export Notifications
Product Export
Email All Products to Store Owner
Import Products via CSV or xlsx File
Product Stock
Retrieve Product Stock
List Product Stock Records
Create Product Stock
Update Product Stock
Bulk Update Product Stock Records
Product Questions & Answers
Retrieve Product Question
Retrieve Product Answer
List Product Questions
List Answers for Question
Create Product Question
Create Product Answer
Update Product Question
Update Product Answer
Delete Product Question
Delete Product Answer
Product Reviews
List Reviews
Count Reviews
Digital Products
Create Downloadable Product
Generate Upload URL
Upload File to S3
Create Product Downloadable
Get Product Downloadables
Delete Product Downloadable
List Store Downloadables
Create Store Downloadable
Delete Store Downloadable
Inventories
Create Location
Update Location
Update Product Stock for Location
List Locations
View Location
Shipping
List Store Shipping Methods
Marketing
Coupons
List Coupons
View Coupon
Create Coupon
Generate Bulk Coupons
Duplicate Coupon
Duplicate Bulk Coupons
Update Coupon Note
Update Coupon
Update Bulk Coupons
Update Coupon Status
Update Bulk Coupons Status
Delete Coupon
Delete Bulk Coupons
Bundle Offers
List Bundle Offers
Loyalty Program
Loyalty Program Status
Loyalty Program Details
Loyalty Program Info
Customer Loyalty Summary
Customer Points History
Activate Loyalty Program
Set Points Expiration Rules
Update Cashback Rule
Create Points Redemption Method
Update Points Redemption Method
Delete Points Redemption Method
Adjust Customer Points
Discount Rules
Customers
Customer Tags
List Customer Tags
Add Customer Tag
ْUpdate Customer Tag
Delete Customer Tag
List Customers
View Customer
Primary Customer List
FInd Customer By Phone Number
Customer Profile
Add Customer
Update Customer
Delete Customer
Add Bulk Customers
Import Customers
Store Settings
📄 User Roles and Permissions
Retrieve Store Manager Profile
Retrieve VAT Settings
List Payment Methods
List Store Operating Countries
Countries and Cities
List Countries
List Cities for Country
Webhooks
Overview
Webhook Health Tracking
Events
Order
Product
Abandoned Cart
Customer
Product Category
APIs
Health Summary
Broken Webhooks
Recover Broken Webhooks
List Webhooks
Create Webhook
Delete Webhook
Delete Webhook By subscriber
App Management
Events
APIs
Subscription Details
Update Usage-Based Charges
Merchant APIs
Copy Page
Orders
Validate Order Request
POST
v1/managers/store/drafts/validate
This endpoint allows Partners to validate an order request details before submitting the order to the create order endpoint. third_create_order - F...
Create Order
POST
v1/managers/store/drafts
This endpoint allows Partners to create orders on behalf of merchants, including products with required customizable fields. third_create_order - F...
Change Order Status
POST
v1/managers/store/orders/{order-id}/change-order-status
Please note that if the order is shipped through an integrated shipping company, then we cannot update the order status from "Ready" to &quo...
Add Order Comment
POST
v1/managers/store/orders/{order_Id}/add-order-comment
The Add Order Comment API allows shipping and fulfilment partners to post real-time shipment updates directly to an order’s activity. Partners can a...
View Order
GET
v1/managers/store/orders/{order-id}/view
Get a specific order by ID. Optionally, when source is provided, the previous_order and next_order fields will be computed among only those orders who...
List Orders
GET
v1/managers/store/orders
Orders can be created either by the customers from the storefronts or by the merchants from their dashboard.Use this endpoint to retrieve a list of or...
List Custom Order Statuses
GET
v1/managers/store/orders/custom-statuses
Fetch main order statuses with their custom sub-statuses for the authenticated manager’s store. orders.read_write - Orders Read & Write ...
List Order Credit Notes
GET
v1/managers/store/orders/{order-id}/credit-notes
The GET Credit Notes endpoint allows you to retrieve a list of credit notes associated with an order from the system. Credit notes are issued for orde...
Previous
Delete Cover Image
Next
Validate Order Request