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 a product
Authorizations
Access token
Path Parameters
id of a particular product
Query Parameters
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 An array of product ULIDs
The ULID of the product
in kg
in kg
in cm
in cm
in cm
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 The ISO 8601 date-time for when review is created.
The email of the reviewer. Must be a valid email, or an empty string.
The ISO 8601 date-time for when review was last modified.
The name of the reviewer.
The rating of the product review. Must be in rang 1-5 (multiple of 0.5)
1 < x < 5Must be a multiple of 0.5The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.
The text for the product review.
Reviews with approved status will be displayed.
approved, rejected, archived, pending 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
An array of product ULIDs
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