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
Catalog APIs
Retrieve a product
GET
/
catalog
/
products
/
{product_id}
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/catalog/products/{product_id} \
--header 'Authorization: Bearer <token>'{
"message": "Products retrieved successfully.",
"success": true,
"content": {
"product": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"product_type": "physical",
"active": true,
"sku": "<string>",
"stock_available": true,
"is_featured": false,
"on_offer": false,
"on_subscription": false,
"on_promotion": false,
"has_variant": false,
"variant_options": [
{
"option_name": "<string>",
"option_value": [
"<string>"
]
}
],
"attributes": [
{
"id": "<string>",
"name": "<string>",
"attribute_type": "single_select",
"attribute_value": "<string>",
"is_visible": true,
"is_filterable": false
}
],
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"shipping": {
"is_free_shipping": true,
"is_fixed_cost_shipping": true,
"fixed_cost_shipping_price": 123,
"shipping_price_including_tax": true,
"availability_description": "<string>",
"ships_internationally": true,
"mid_code": "<string>",
"country_of_origin": "<string>",
"tax_region": "<string>",
"tax_type": "<string>",
"tax_rate": 123
},
"tags": [
"<string>"
],
"category_ids": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"promotion": [
{
"type": "discount",
"details": {
"discount_type": "percent",
"discount_percent": 10,
"discount_amount": 150.65,
"max_amount": 2500
}
}
],
"subscription": [
{
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": true,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"quantity": 123,
"billing_trial_days": 123
}
],
"packaging": {
"pack_width": 123,
"pack_height": 123,
"pack_length": 123,
"pack_dry_weight": 123,
"calculated_weight": 123,
"units_per_pack": 123,
"volume_of_packsize": 123,
"vertical_rotation": true,
"shipper_width": 123,
"shipper_height": 123,
"shipper_length": 123,
"shipper_dry_weight": 123,
"units_per_shipper": 123
},
"variants": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"active": true,
"stock_available": true,
"on_subscription": true,
"on_promotion": true,
"associated_options": {},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"sku": "<string>",
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"subscription": [
{
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": true,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"quantity": 123,
"billing_trial_days": 123
}
],
"promotion": [
{
"type": "discount",
"details": {
"discount_type": "percent",
"discount_percent": 10,
"discount_amount": 150.65,
"max_amount": 2500
}
}
],
"shipping": {
"is_free_shipping": true,
"is_fixed_cost_shipping": true,
"fixed_cost_shipping_price": 123,
"shipping_price_including_tax": true,
"availability_description": "<string>",
"ships_internationally": true,
"mid_code": "<string>",
"country_of_origin": "<string>",
"tax_region": "<string>",
"tax_type": "<string>",
"tax_rate": 123
}
}
],
"upselling_product_ids": [
"01F3Z7KG06J4ACWH1C4926KJEB"
],
"crossselling_product_ids": [
"01F3Z7KG06J4ACWH1C4926KJEB"
],
"reviews": [
{
"rating": 3,
"review_text": "<string>",
"name": "<string>",
"email": "[email protected]",
"status": "pending",
"is_featured": false,
"tags": [
"<string>"
],
"review_date": "2023-11-07T05:31:56Z",
"images": [
{
"blur_url": "<string>",
"thumbnail_url": "<string>",
"standard_url": "<string>"
}
],
"videos": [
{
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"playback": {
"hls": "<string>",
"dash": "<string>"
},
"duration": "<string>",
"size": "<string>"
}
],
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"bundle_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"quantity": 123,
"sku": "<string>",
"stock_available": true,
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"reviews_rating_sum": 123,
"reviews_count": 123
}
],
"sales_channels": [
{
"id": 123,
"name": "CRED",
"description": "CRED store",
"active": true,
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"metadata": [
{
"name": "<string>",
"value": "<string>"
}
],
"seo": {
"meta_title": "<string>",
"meta_description": "<string>",
"meta_keywords": [
"<string>"
],
"slug": "<string>"
},
"reviews_tags": [
"<string>"
]
}
}
}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
200
application/json
Success response
The ULID of the product
Available options:
physical, digital, bundle Available options:
color, single_select, multi_select, text, date, radio, image, file, number, currency Available options:
GST Available options:
discount, free_goods, volume_based Available options:
percentage, fixed-amount required if discount_type = percentage
required if discount_type = fixed-amount
required for B2B flow only.
Billing interval determines the frequency for which the customer is charged for the subscription itself.
Available options:
weekly, monthly, annually Optionally limit the number of times this subscription will invoice the customer.
order interval defines the frequency of when the subscription sends customers the product
Available options:
weekly, monthly, annully 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
Use in digital product only for trial period
in cm
in cm
in cm
in kg
in kg
variant id
variant name
variant sku
Available options:
GST Billing interval determines the frequency for which the customer is charged for the subscription itself.
Available options:
weekly, monthly, annually Optionally limit the number of times this subscription will invoice the customer.
order interval defines the frequency of when the subscription sends customers the product
Available options:
weekly, monthly, annully 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
Use in digital product only for trial period
An array of product ULIDs
An array of product ULIDs
The rating of the product review. Must be in rang 1-5 (multiple of 0.5)
Required range:
1 < x < 5Must be a multiple of 0.5The text for the product review.
The name of the reviewer.
The email of the reviewer. Must be a valid email, or an empty string.
Reviews with approved status will be displayed.
Available options:
approved, rejected, archived, pending The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.
The ISO 8601 date-time for when review is created.
The ISO 8601 date-time for when review was last modified.
Available options:
GST curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/catalog/products/{product_id} \
--header 'Authorization: Bearer <token>'{
"message": "Products retrieved successfully.",
"success": true,
"content": {
"product": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"short_description": "<string>",
"product_type": "physical",
"active": true,
"sku": "<string>",
"stock_available": true,
"is_featured": false,
"on_offer": false,
"on_subscription": false,
"on_promotion": false,
"has_variant": false,
"variant_options": [
{
"option_name": "<string>",
"option_value": [
"<string>"
]
}
],
"attributes": [
{
"id": "<string>",
"name": "<string>",
"attribute_type": "single_select",
"attribute_value": "<string>",
"is_visible": true,
"is_filterable": false
}
],
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"shipping": {
"is_free_shipping": true,
"is_fixed_cost_shipping": true,
"fixed_cost_shipping_price": 123,
"shipping_price_including_tax": true,
"availability_description": "<string>",
"ships_internationally": true,
"mid_code": "<string>",
"country_of_origin": "<string>",
"tax_region": "<string>",
"tax_type": "<string>",
"tax_rate": 123
},
"tags": [
"<string>"
],
"category_ids": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"promotion": [
{
"type": "discount",
"details": {
"discount_type": "percent",
"discount_percent": 10,
"discount_amount": 150.65,
"max_amount": 2500
}
}
],
"subscription": [
{
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": true,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"quantity": 123,
"billing_trial_days": 123
}
],
"packaging": {
"pack_width": 123,
"pack_height": 123,
"pack_length": 123,
"pack_dry_weight": 123,
"calculated_weight": 123,
"units_per_pack": 123,
"volume_of_packsize": 123,
"vertical_rotation": true,
"shipper_width": 123,
"shipper_height": 123,
"shipper_length": 123,
"shipper_dry_weight": 123,
"units_per_shipper": 123
},
"variants": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"active": true,
"stock_available": true,
"on_subscription": true,
"on_promotion": true,
"associated_options": {},
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"sku": "<string>",
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"subscription": [
{
"subscription_plan": "<string>",
"subscription_price": 123,
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"fulfill_separately": true,
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123,
"quantity": 123,
"billing_trial_days": 123
}
],
"promotion": [
{
"type": "discount",
"details": {
"discount_type": "percent",
"discount_percent": 10,
"discount_amount": 150.65,
"max_amount": 2500
}
}
],
"shipping": {
"is_free_shipping": true,
"is_fixed_cost_shipping": true,
"fixed_cost_shipping_price": 123,
"shipping_price_including_tax": true,
"availability_description": "<string>",
"ships_internationally": true,
"mid_code": "<string>",
"country_of_origin": "<string>",
"tax_region": "<string>",
"tax_type": "<string>",
"tax_rate": 123
}
}
],
"upselling_product_ids": [
"01F3Z7KG06J4ACWH1C4926KJEB"
],
"crossselling_product_ids": [
"01F3Z7KG06J4ACWH1C4926KJEB"
],
"reviews": [
{
"rating": 3,
"review_text": "<string>",
"name": "<string>",
"email": "[email protected]",
"status": "pending",
"is_featured": false,
"tags": [
"<string>"
],
"review_date": "2023-11-07T05:31:56Z",
"images": [
{
"blur_url": "<string>",
"thumbnail_url": "<string>",
"standard_url": "<string>"
}
],
"videos": [
{
"cover_image_url": "<string>",
"video_preview_url": "<string>",
"playback": {
"hls": "<string>",
"dash": "<string>"
},
"duration": "<string>",
"size": "<string>"
}
],
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"bundle_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"quantity": 123,
"sku": "<string>",
"stock_available": true,
"pricing": {
"currency": "<string>",
"tax_region": "<string>",
"tax_type": "GST",
"tax_rate": 123,
"price_including_tax": false,
"listing_price": 123,
"selling_price": 123,
"min_order_quantity": 123,
"max_order_quantity": 123
},
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>"
}
],
"reviews_rating_sum": 123,
"reviews_count": 123
}
],
"sales_channels": [
{
"id": 123,
"name": "CRED",
"description": "CRED store",
"active": true,
"created_at": "2023-05-25T14:15:22Z",
"modified_at": "2023-05-25T14:15:22Z"
}
],
"metadata": [
{
"name": "<string>",
"value": "<string>"
}
],
"seo": {
"meta_title": "<string>",
"meta_description": "<string>",
"meta_keywords": [
"<string>"
],
"slug": "<string>"
},
"reviews_tags": [
"<string>"
]
}
}
}