Test the product details endpoint with your data.
Get detailed information about a specific product in your inventory
The details endpoint allows you to retrieve comprehensive information about a specific product already in your inventory. You can identify the product using an EAN, ASIN, MINSAN code or SKU.
The returned details include general information, descriptions, technical specifications, key features, images, and metadata.
GET https://api.commerceclarity.com/api/v1/products/details/{id}/{country?}
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Required | The unique product identifier |
country |
string | Optional | Two-letter ISO country code (e.g., IT, EN, DE). If not specified, uses the user default country |
# Basic request (uses default country)
curl -X GET "https://api.commerceclarity.com/api/v1/products/details/507f1f77bcf86cd799439011" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
# Request with specific country
curl -X GET "https://api.commerceclarity.com/api/v1/products/details/507f1f77bcf86cd799439011/it" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
$client = new \GuzzleHttp\Client();
$productId = '507f1f77bcf86cd799439011';
$country = 'it'; // Optional
$url = 'https://api.commerceclarity.com/api/v1/products/details/' . $productId;
if ($country) {
$url .= '/' . $country;
}
$response = $client->get($url, [
'headers' => [
'Authorization' => 'Bearer ' . $apiToken,
'Accept' => 'application/json',
]
]);
$data = json_decode($response->getBody(), true);
const productId = '507f1f77bcf86cd799439011';
const country = 'it'; // Optional
let url = `https://api.commerceclarity.com/api/v1/products/details/${productId}`;
if (country) {
url += `/${country}`;
}
const response = await fetch(url, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiToken}`,
'Accept': 'application/json'
}
});
const data = await response.json();
{
"status": "success",
"product": {
"name": "Product Name",
"brand": "Brand Name",
"code": "8001234567890",
"sku": "CUSTOM-SKU-123",
"product_handle": "product-name-handle",
"google_category": [
"Home and Garden",
"Appliances"
],
"google_category_id": "619",
"customer_category": null,
"custom_category_id": null,
"description": "Complete product description...",
"short_description": "Short product description",
"specifications": {
"Design": [
"Capacity: 12 L",
"Product color: Black, Yellow"
],
"Performance": [
"Cleaning type: Dry",
"Noise level: 78 dB"
],
"Weight & dimensions": [
"Width: 11\" (280 mm)",
"Height: 10.6\" (270 mm)"
]
},
"key_features": [
"Feature 1",
"Feature 2",
"Feature 3"
],
"pictures": [
"https://api.commerceclarity.com/storage/product/image1.jpg",
"https://api.commerceclarity.com/storage/product/image2.jpg"
],
"tags": ["tag1", "tag2"],
"family_attr": [
{
"id": "warranty_period",
"name": "Warranty Period",
"type": "number",
"value": {
"value": 24,
"unit": "months"
}
}
],
"global_attr": [
{
"id": "color",
"name": "Color",
"type": "multi-select",
"value": [
{
"value": "Black",
"value_id": null
},
{
"value": "Yellow",
"value_id": null
}
]
},
{
"id": "material",
"name": "Material",
"type": "multi-select",
"value": [
{
"value": "Steel",
"value_id": null
}
]
}
],
"meta_title" => "Meta Title for SEO",
"meta_description" => "Meta Description for SEO",
"family": "Product Family Name",
"country": "it",
"publication_state": "online",
"validation_messages": [],
"updated_at": "2024-01-15T10:30:00.000000Z",
"created_at": "2024-01-15T10:30:00.000000Z"
}
}
{
"status": "error",
"message": "Product not found",
"code": 404
}
The response contains complete product information:
| Field | Type | Description |
|---|---|---|
name |
string | Complete product name |
brand |
string | Product brand |
code |
string | Main product code (EAN, ASIN or MINSAN) |
sku |
string|null | Customer SKU or custom code |
product_handle |
string|null | URL-friendly product handle |
google_category |
array | Corresponding Google category ID |
google_category_id |
string | Google category taxonomy ID |
customer_category |
string|null | Custom category assigned by user |
custom_category_id |
string|null | List of user category IDs |
description |
string | Complete product description |
short_description |
string | Short product description |
specifications |
object | List of product technical specifications as name-value pairs |
key_features |
array | List of main product features |
pictures |
array | Array of product image URLs |
tags |
array|null | Product SEO metadata (title, meta description, meta keywords) |
family_attr |
array | Array of family-specific custom attributes (each with id, name, type, value) |
global_attr |
array | Array of global custom attributes (each with id, name, type, value) |
family |
string | Product family name |
meta_title |
string|null | Meta title for SEO purposes |
meta_description |
string|null | Meta description for SEO purposes |
country |
string | Country code for this product version |
publication_state |
string | Product publication status (e.g. "online", "ready") |
validation_messages |
array | Any validation messages or warnings related to the product |
updated_at |
string | Last update timestamp (ISO 8601) |
created_at |
string | Product creation timestamp (ISO 8601) |