GET Get Product
GET /products/{id}
Operation ID: Get Product. Tags: products. Security: oauth2_application.
Action to get product information.
This endpoint may return the following faults:
- 404 - ProductNotFoundException - Indicates the product is not found.
Parameters
id(path, string, required) The product ID.
Minimum length: 1.site_id(query, string) The site context.expand(query, array of string)The list of expansions that can be applied to the product. They are:
-
'all' will retrieve all the product properties.
-
'availability' will retrieve the following properties:
-
ats
-
in_stock
-
online
-
-
'images' will retrieve the following properties:
-
image
-
image_groups
-
-
'all_images' used with images will retrieve the following properties, including the images specified for its variants and variation groups:
-
image
-
image_groups
-
-
'categories' will retrieve the following properties:
-
assigned_categories
-
primary_category
-
classification_category
-
-
'options' will retrieve the following properties:
-
product_options
-
-
'prices' will retrieve the following properties:
-
price
-
price_currency
-
-
'variations' will retrieve the following properties:
-
master
-
variation_attributes
-
variation_groups
-
variation_values
-
variants
-
-
'sets' will retrieve the following properties:
-
set_products
-
product_sets
-
-
'bundles' will retrieve the following properties:
-
product_bundles
-
bundled_products
-
Note that only variants with variation values are retrieved for a product of type variation master.
-
Responses
- 404
ProductNotFoundException- Indicates the product is not found.Media type:
application/json, text/xml. Schema:fault. - default
Media type:
application/json, text/xml. Schema:product.