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
Retrieve all products
Authorizations
Access token
Query Parameters
page number of pagination list
x > 1
no of rows per page
x > 1
JSON string format: {"field1":"asc", "field2":"desc"}
filter products by categories
use this param only if different pricing is configured as per customer group
Response
color
, single_select
, multi_select
, text
, date
, radio
, image
, file
, number
, currency
GST
The ULID of the product
GST
physical
, digital
, bundle
percentage
, fixed-amount
required for B2B flow only.
required if discount_type = fixed-amount
required if discount_type = percentage
discount
, free_goods
, volume_based
weekly
, monthly
, annually
Billing interval determines the frequency for which the customer is charged for the subscription itself.
Optionally limit the number of times this subscription will invoice the customer.
Use in digital product only for trial period
weekly
, monthly
, annully
order interval defines the frequency of when the subscription sends customers the product
By default this is set to unlimited, meaning the subscription will fulfill indefinitely. Changing the Limit to 10 would force the subscription to end after the tenth interval had been fulfilled.
The quantity of the plan to which the customer should be subscribed
variant id
variant name
GST
variant sku
weekly
, monthly
, annually
Billing interval determines the frequency for which the customer is charged for the subscription itself.
Optionally limit the number of times this subscription will invoice the customer.
Use in digital product only for trial period
weekly
, monthly
, annully
order interval defines the frequency of when the subscription sends customers the product
By default this is set to unlimited, meaning the subscription will fulfill indefinitely. Changing the Limit to 10 would force the subscription to end after the tenth interval had been fulfilled.
The quantity of the plan to which the customer should be subscribed