Product Details

get complete details of a product

Get Product Details

GET ‎https://<domain>/<api prefix>/<version>/commerce/product/product-details/

This API endpoint will return details of the product.

Query Parameters

Headers

HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "displaydata": [
            {
                "attributes": {
                    "<machine_code>": {
                        "attr_id": <attribute_id>,
                        "language": "<language>",
                        "attr_name": "<attr_name>",
                        "attr_type": "<attr_type>",
                        "attr_value": "<attr_value>",
                        "machine_code": "<machine_code>"
                    },
                    ...
                },
                "extra_discount": "<extra_discount>",
                "additional_data": "<additional_data>",
                "varient_attributes": {
                    "541": {
                        "sku": "<sku>",
                        "<machine_code>": {
                            "attr_id": <attr_id>,
                            "language": "<language>",
                            "attr_name": "<attr_name>",
                            "attr_type": "<attr_type>",
                            "is_unique": <is_unique>,
                            "attr_value": "<attr_value>",
                            "is_display": <is_display>,
                            "attr_widget": "<attr_widget>",
                            "is_required": <is_required>,
                            "machine_code": "<machine_code>"
                        },
                        ...
                    }
                },
                "description": "<description>",
                "short_description": "<short_description>",
                "currency": "<currency>",
                "images": [
                    "<images>"
                ]
            }
        ],
        "rating": {
            "total_rating": <total_rating>,
            "rating": []
        },
        "media_path": "<media_path>",
        "reserve": <reserve>,
        "similar_products": []
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/commerce/product/product-details/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/commerce/product/product-details/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Responses

PreviousProduct CatalogueNextProduct Review

Last updated