Get a single Product
GET
/api/v2/products/{id}.json
Retrieve a single Product using its ID.
Scopes
Requires either the products or products.readonly OAuth
scope.
Parameters
Accepts the following parameters:
id
required
The ID of the Product is supplied as a path parameter. |
Response
Returns an object with the following properties:
success
A boolean where a value of true represents a successful request.
|
status
The HTTP status code e.g. 200 for a successful request.
|
data
Contains the Product object. |
JSON Example
An example of JSON returned.
{
"success": true,
"status": 200,
"data": {
"id": 3066,
"type": "physical",
"priceType": "buy",
"variantOf": null,
"quickfind": 1,
"sku": "EX-D1",
"barcode": "",
"commodityCode": "",
"status": "public",
"isActive": true,
"title": "Unicorn Tears Gin Liqueur",
"alias": "/product/unicorn-tears-gin-liqueur",
"fullDescription": "...",
"description": "The sweet tears of unicorns, bottled - juicy passion-fruit and tropical mango flavoured",
"metaTitle": "",
"metaDescription": "",
"metaKeywords": "",
"workflowId": null,
"manufacturerId": null,
"range": "",
"model": "",
"isMadeToOrder": false,
"partNumber": "",
"packagedWeight": 0.75,
"packagedWidth": 0,
"packagedHeight": 0,
"packagedDepth": 0,
"isDiscontinued": false,
"discontinuedOn": null,
"discontinuedBy": null,
"discontinuedReason": null,
"createdOn": "2019-11-09T01:02:00+00:00",
"createdBy": 213,
"modifiedOn": "2022-01-06T21:19:28+00:00",
"modifiedBy": 213,
"publishStartOn": null,
"publishEndOn": null,
"isStockLimited": false,
"lowStockLevel": 0,
"currentStock": null,
"taxClassId": 1,
"leadTimeMin": 0,
"leadTimeMax": 0,
"orderQuantityMin": 1,
"orderQuantityMax": 0,
"shippingClassId": null,
"bandId": null,
"supersededBy": null,
"isPurchasable": true,
"isSearchable": true,
"isFeatured": false,
"condition": "new",
"template": null,
"isIndexable": true,
"averageRating": null,
"countRating": 0
}
}