v1
latestOpenAPI 3.0.32026-07-173196215.4 KBGet a variant
Get one variant by variantId.
Path parameters
Get variant with specified variantId.
Query parameters
In case you are operating multiple shops (for example, for different domain names or different languages), each shop is identified by its specific shopId
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.
Adjust variant price based on the specified pricePromotionKey. If the variant does not have a matching price promotion, the default price is returned.
Include related variant resources, for example, the attributes of a variant can be included using with=attributes or with=attributes:key(plusSize). Multiple includes are separated by commas with=attributes,advancedAttributes,lowestPriorPrice.
| with | includes |
|---|---|
| attributes | all attributes |
| attributes:key(<key>,<key>,...) | only attributes with specified keys |
| attributes:type(<type>,<type>,...) | only attributes with specified types |
| advancedAttributes | all advancedAttributes |
| advancedAttributes:key(<key>,<key>,...) | only advancedAttributes with specified keys |
| advancedAttributes:type(<type>,<type>,...) | only advancedAttributes with specified types |
| lowestPriorPrice | include variant lowestPriorPrice |
| merchant | include merchant information |
Response
successful operation
Example response
{
"price": {
"appliedReductions": [
{
"category": "campaign",
"type": "relative"
}
]
},
"productId": 123456,
"referenceKey": "563843898",
"firstLiveAt": "2023-01-26T09:30:15+00:00",
"stock": {
"expectedAvailabilityAt": "2023-01-26"
},
"createdAt": "2023-01-26T09:30:15+00:00",
"updatedAt": "2023-01-26T09:30:15+00:00"
}