listProductVariants
get
/ccagent/v1/variants
List Product Variants. Returns a list of variants available for a given Product. A similar endpoint exists for Storefront, that is not implemented currently. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site.
Request
Supported Media Types
- application/json
Query Parameters
-
productId: string
product id
-
showInactiveSkus(optional): boolean
Return inactive skus only if its value is true
Header Parameters
-
x-ccsite(optional): string
the site id on which the orders is laced
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listProductVariants_response
Type:
Show Source
object
-
items(optional):
array items
Variants of the product.
Nested Schema : items
Type:
Show Source
object
-
mapKeyPropertyAttribute(optional):
string
specifies the key for optionValueMap in backing map.
-
optionName(optional):
string
Variant name
-
optionValueMap(optional):
object optionValueMap
Variant option information.
Nested Schema : optionValueMap
Type:
object
Variant option information.
Show Source
-
items(optional):
array items
Variant value map.
Nested Schema : items
Type:
Show Source
object
-
Variant value(optional):
string
Variant value containing value and code (eg. 'black':0)
Example Response (application/json)
[
{
"optionValueMap":{
"Silver":1,
"Neon":2,
"Black":0
},
"mapKeyPropertyAttribute":"sku-camcorder_color",
"optionName":"color"
},
{
"optionValueMap":{
"27x optical/320x digital":4,
"20x optical/320x digital":3,
"2x optical/130x digital":0
},
"mapKeyPropertyAttribute":"sku-camcorder_zoom",
"optionName":"zoom"
}
]
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|20032|Product Id passed is null or empty|
|20031|Product Id '12' is invalid or non-existent|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code