Retrieve a variant details
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"variant": {
"id": "<string>",
"active": true,
"stock_available": true,
"is_default": true,
"short_description": "<string>",
"metadata": {},
"sku": "<string>",
"slug": "<string>",
"hsn_code": "<string>",
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"product_type": "physical",
"product_id": "<string>",
"product_name": "<string>",
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"variant_attributes": [
{
"attribute_id": "<string>",
"attribute_name": "<string>",
"attribute_type": "text",
"attribute_value": "<string>",
"key": "<string>"
}
],
"name": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"description": "<string>",
"videos": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"video_preview_url": "<string>",
"video_stream_hls_url": "<string>",
"video_stream_dash_url": "<string>",
"image_thumbnail_url": "<string>",
"video_duration": 123,
"file_id": "<string>"
}
],
"seo": {
"title": "<string>",
"description": "<string>",
"keywords": "<array>"
},
"shipping": {
"handling_charge": 1
},
"packaging": {
"pack_width": 123,
"pack_height": 123,
"pack_length": 123,
"pack_dry_weight": 123,
"units_per_pack": 123,
"vertical_rotation": true,
"shipper_width": 123,
"shipper_height": 123,
"shipper_length": 123,
"shipper_dry_weight": 123,
"units_per_shipper": 123
},
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"kind": "storefront",
"active": true
}
],
"related_products": {
"upsell": [
{
"id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_type": "physical",
"status": "draft",
"tags": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"slug": "<string>",
"sku": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"active": true,
"stock_available": true,
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
]
}
],
"cross_sell": [
{
"id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_type": "physical",
"status": "draft",
"tags": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"slug": "<string>",
"sku": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"active": true,
"stock_available": true,
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
]
}
]
},
"promotions": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"id": "<string>",
"expires_at": "<string>"
},
"subscriptions": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"subscription_plan_id": "<string>",
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
}
}Marketplace Catalog
Retrieve a variant details
Retrieve a product variant details
GET
/
catalog
/
products
/
{id}
/
variants
/
{variant_id}
Retrieve a variant details
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/catalog/products/{id}/variants/{variant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"variant": {
"id": "<string>",
"active": true,
"stock_available": true,
"is_default": true,
"short_description": "<string>",
"metadata": {},
"sku": "<string>",
"slug": "<string>",
"hsn_code": "<string>",
"on_offer": true,
"on_promotion": true,
"on_subscription": true,
"product_type": "physical",
"product_id": "<string>",
"product_name": "<string>",
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
],
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"variant_attributes": [
{
"attribute_id": "<string>",
"attribute_name": "<string>",
"attribute_type": "text",
"attribute_value": "<string>",
"key": "<string>"
}
],
"name": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"description": "<string>",
"videos": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"video_preview_url": "<string>",
"video_stream_hls_url": "<string>",
"video_stream_dash_url": "<string>",
"image_thumbnail_url": "<string>",
"video_duration": 123,
"file_id": "<string>"
}
],
"seo": {
"title": "<string>",
"description": "<string>",
"keywords": "<array>"
},
"shipping": {
"handling_charge": 1
},
"packaging": {
"pack_width": 123,
"pack_height": 123,
"pack_length": 123,
"pack_dry_weight": 123,
"units_per_pack": 123,
"vertical_rotation": true,
"shipper_width": 123,
"shipper_height": 123,
"shipper_length": 123,
"shipper_dry_weight": 123,
"units_per_shipper": 123
},
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"kind": "storefront",
"active": true
}
],
"related_products": {
"upsell": [
{
"id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_type": "physical",
"status": "draft",
"tags": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"slug": "<string>",
"sku": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"active": true,
"stock_available": true,
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
]
}
],
"cross_sell": [
{
"id": "<string>",
"product_id": "<string>",
"product_name": "<string>",
"product_type": "physical",
"status": "draft",
"tags": [
"<string>"
],
"reviews_rating_sum": 123,
"reviews_count": 123,
"hsn_code": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"slug": "<string>",
"sku": "<string>",
"associated_options": [
{
"attribute_id": "<string>",
"attribute_value": "<string>",
"attribute_name": "<string>",
"attribute_type": "single-select",
"key": "<string>"
}
],
"active": true,
"stock_available": true,
"images": [
{
"title": "<string>",
"alternate_text": "<string>",
"sort_order": 123,
"url_tiny": "<string>",
"url_thumbnail": "<string>",
"url_standard": "<string>",
"url_zoom": "<string>",
"file_id": "<string>",
"file_type": "image"
}
],
"pricing": [
{
"customer_group_id": "<string>",
"cost_price": 123,
"listing_price": 123,
"selling_price": 123,
"tax_rate": 123,
"min_order_quantity": 1,
"max_order_quantity": 123,
"incremental_quantity": 1,
"tax_type": "GST"
}
]
}
]
},
"promotions": {
"promotion_type": "discount",
"starts_at": "<string>",
"details": [
{
"discount_type": "percentage",
"discount_percent": 123,
"customer_group_id": "<string>",
"minimum_quantity": 1,
"maximum_quantity": 123,
"maximum_discount_amount": 123
}
],
"id": "<string>",
"expires_at": "<string>"
},
"subscriptions": [
{
"subscription_plan": "<string>",
"billing_interval": 123,
"billing_frequency": "monthly",
"billing_limit": 123,
"billing_trial_days": 0,
"fulfill_separately": true,
"subscription_price": [
{
"suscription_price": 123,
"minimum_quantity": 1,
"customer_group_id": "<string>"
}
],
"subscription_plan_id": "<string>",
"order_interval": 123,
"order_frequency": "monthly",
"order_limit": 123
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Was this page helpful?
⌘I