API Documentation
Authentication APIs
- Login & Register
- Create & Manage Users
Catalog APIs
- GETList all products
- GETList all skus
- GETRetrieve a product
- GETRetrieve product variants
- GETRetrieve variant detail
- GETList all categories
- GETRetrieve product reviews
- POSTCreate product review
- GETRetrieve similar products
- GETRetrieve up sell products
- GETRetrieve cross sell products
- GETRetrieve recommended products
- POSTDatocms webhook
Cart & Checkout APIs
- Cart
- Checkout
Coupons & promotions API
Customers API
Orders APIs
Shipping APIs
Analytics
Campaigns API
Retrieve product variants
Authorizations
Access token
Path Parameters
ulid of a particular product
Query Parameters
use this param only if different pricing is configured as per customer group
Response
variant id
variant name
GST percentage, fixed-amount required for B2B flow only.
required if discount_type = fixed-amount
required if discount_type = percentage
discount, free_goods, volume_based 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