v1
latestOpenAPI 3.0.32026-07-173196215.4 KBproducts
Get a product
Get one product by productId.
get/v1/products/{productId}
Path parameters
productIdinteger required
Get product with specified productId.
Query parameters
campaignKeystring
Adjust prices based on the specified campaignKey. If results are not having a matching campaign, the default price is returned.
Please note, that campaign prices are stored in advance and available earlier than the campaign starts.
withstring[]
Include related product resources, for example, the attributes of a product can be included using with=attributes or with=attributes:key(plusSize). Nested includes can be included with with=variants.attributes. Multiple includes are separated by commas with=siblings,variants.
| with | includes |
|---|---|
| attributes | see attributes filtering below |
| advancedAttributes | see attributes filtering below |
| variants | full variants |
| variants.<include> | partial variants (see available includes for variants in /variants endpoint) |
| images | images (included by default) |
| images.attributes | see attributes filtering below |
| categories | categories |
| categories:hidden(true) | also include hidden categories |
| categories.countryLevelCustomData | include country custom data information |
| categories.shopLevelCustomData | include shop custom data information |
| categories.categoryProperties:name(property_name) | only return specified categoryProperties for included categories |
| definingAttributes | definingAttributes |
| siblings | sibling products |
| siblings.<include> | partial sibling products (see available includes for products in /products endpoint) |
| priceRange | priceRange |
| lowestPriorPrice | lowestPriorPrice |
| reductionRange | reductionRange |
| searchCategoryIds | searchCategoryIds |
| baseCategories | baseCategories |
| filters for with=attributes, with=advancedAttributes and with=images.attributes | includes |
|---|---|
| attributes | all attributes |
| attributes:key(<key>|<key>|...) | only attributes with specified keys |
| attributes:type(<type>|<type>|...) | only attributes with specified types |
pricePromotionKeystring
Adjust variant price based on the specified pricePromotionKey. If the variant does not have a matching price promotion, the default price is returned.
Response
successful operation