Catalog
- GETRetrieve all products
- POSTCreate product
- GETRetrieve skus
- GETRetrieve product details
- PUTUpdate product details
- DELDelete product
- GETRetrieve product variants
- POSTCreate variant
- POSTUpdate variants in bulk
- GETRetrieve a variant details
- PUTUpdate a variant
- DELDelete a variant
- GETRetrieve product inventory
- POSTUpdate product inventory
- GETRetrieve product inventory activities
- PUTUpdate product inventory activities
- POSTCreate product inventory activities
- GETRetrieve product reviews
- GETRetrieve product review
- PUTUpdate product review
- DELDelete product review
- GETRetrieve all categories
- POSTCreate category
- GETRetrieve category
- PUTUpdate category
- DELDelete category
- GETRetrieve all attributes
- POSTCreate attribute
- GETRetrieve attribute
- PUTUpdate attribute
- DELDelete attribute
- POSTAdd product pricing
- PUTUpdate product pricing
- DELDelete product pricing
- POSTAdd product image
- PUTUpdate product image
- DELDelete product image
- GETRetrive sku detail
Auth
- PUTActivate user account
- PUTDeactivate user account
- GETCheck domain availability
- GETRetrieve all roles
- POSTCreate new role
- PUTUpdate role
- DELDelete role
- GETRetrieve all permissions of a role
- POSTAdd permission to role
- DELRemove permission from role
- GETRetrieve all members
- POSTCreate new member
- GETRetrieve member detail
- PUTUpdate member details
- DELDelete member
- GETRetrieve all roles of a member
- POSTAssigne role to member
- DELRemove role from member
Coupons & promotions API
- GETList all coupons
- POSTCreate coupon
- GETRetrieve coupon details
- PUTUpdate coupon
- DELDelete coupon
- GETList all coupon codes
- POSTAdd coupon code
- GETList all coupon customers
- GETRetrieve coupon usage
- GETList all promotions
- POSTCreate promotion
- GETRetrieve promotion details
- PUTUpdate promotion
- DELDelete promotion
- GETList all promotion usage
- GETList all promotion customers
Warehouse
Orders API
Shipping API
Customers API
Segments API
Payments API
Media Gallery API
List all orders
Authorizations
Access token
Query Parameters
page number of pagination list
x > 1no of rows per page
x > 1JSON string format: {"field1":"asc", "field2":"desc"}
array of string
user id
Response
Amount of credit balance used in the order.
Total amount for the order, including all items, taxes, and discounts.
Indicates whether the order has a refund associated with it or not.
Number of loyalty points redeemed in the order.
Indicates whether the order includes subscription items.
Date and time when the order was placed.
GST Total count of items included in the order.
Unique number associated with the order.
Current payment status of the order (e.g., "pending," "success," "failed").
pending, success, failed, partially_paid Date and time when the payment for the order was successfully processed.
Current status of the order (e.g., "pending," "processing," "shipped," etc.).
draft, awaiting_approval, cancelled, shipped, delivered, awaiting_shipment Amount remaining to be paid for the order.