docs
  1. Storefront Api
  2. Resources
  3. Variants
  4. Get A Variant

Get a Variant

Get a variant

Path Parameters

ParameterDetails
variantId
  • required
integer
Example:
987654

Query Parameters

ParameterDetails
shopId
integer
Example:
10001
campaignKey
string
Example:
e6413f96-b47c-4be1-be61-d2206adeae71
pricePromotionKey
string
Example:
ppk-123
with
Array of strings
Default:
[]
string
Example:
attributes

Header Parameters

ParameterDetails
X-Shop-Id
integer
Example:
10001

Responses

200
successful operation
application/json
Success
id
integer
Example:
987654
object
appliedPricePromotionKey
string
Example:
promotion_key_123
object
object
required
object
referenceKeyrequired
string
Example:
563843898
firstLiveAtrequired
string
Example:
2023-01-26T09:30:15+00:00
required
object
required
object
object
createdAtrequired
string
Example:
2023-01-26T09:30:15+00:00
updatedAtrequired
string
Example:
2023-01-26T09:30:15+00:00
productIdrequired
integer
Example:
123456
400
Required query parameter missing / invalid
application/json
Error
401
Authentication information is missing or invalid
application/json
Error
404
The specified resource was not found
application/json
Error
429
Triggered when a client exceeds the API request limit.
application/json
Error
GET/v1/variants/{variantId}

Request samples

Response samples

200
Content type: application/json
Provide Feedback