Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listProductVariants_response

Type: object

Show Source

• items(optional): array items
  Variants of the product.

{
    "properties":{
        "items":{
            "description":"Variants of the product.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "optionValueMap":{
                        "description":"Variant option information.",
                        "type":"object",
                        "properties":{
                            "items":{
                                "description":"Variant value map.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "Variant value":{
                                            "description":"Variant value containing value and code (eg. 'black':0)",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "mapKeyPropertyAttribute":{
                        "description":"specifies the key for optionValueMap in backing map.",
                        "type":"string"
                    },
                    "optionName":{
                        "description":"Variant name",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Variants of the product.

Show Source

• Array of: object items

{
    "description":"Variants of the product.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "optionValueMap":{
                "description":"Variant option information.",
                "type":"object",
                "properties":{
                    "items":{
                        "description":"Variant value map.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "Variant value":{
                                    "description":"Variant value containing value and code (eg. 'black':0)",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            },
            "mapKeyPropertyAttribute":{
                "description":"specifies the key for optionValueMap in backing map.",
                "type":"string"
            },
            "optionName":{
                "description":"Variant name",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• mapKeyPropertyAttribute(optional): string
  specifies the key for optionValueMap in backing map.
• optionName(optional): string
  Variant name
• optionValueMap(optional): object optionValueMap
  Variant option information.

{
    "type":"object",
    "properties":{
        "optionValueMap":{
            "description":"Variant option information.",
            "type":"object",
            "properties":{
                "items":{
                    "description":"Variant value map.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Variant value":{
                                "description":"Variant value containing value and code (eg. 'black':0)",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "mapKeyPropertyAttribute":{
            "description":"specifies the key for optionValueMap in backing map.",
            "type":"string"
        },
        "optionName":{
            "description":"Variant name",
            "type":"string"
        }
    }
}

Nested Schema : optionValueMap

Type: object

Variant option information.

Show Source

• items(optional): array items
  Variant value map.

{
    "description":"Variant option information.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Variant value map.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Variant value":{
                        "description":"Variant value containing value and code (eg. 'black':0)",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Variant value map.

Show Source

• Array of: object items

{
    "description":"Variant value map.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Variant value":{
                "description":"Variant value containing value and code (eg. 'black':0)",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Variant value(optional): string
  Variant value containing value and code (eg. 'black':0)

{
    "type":"object",
    "properties":{
        "Variant value":{
            "description":"Variant value containing value and code (eg. 'black':0)",
            "type":"string"
        }
    }
}

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|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top