getProduct

get

/ccadmin/v1/products/{id}

Get Product. Gets a detailed product information based on product ID provided. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getProduct_response
Type: object
Show Source
Nested Schema : addOnProducts
Type: array
Array of AddOn products.
Show Source
Nested Schema : childSKUs
Type: array
Array having the properties of child SKU of the product.
Show Source
Nested Schema : defaultProductListingSku
Type: object
Default Product Listing Sku product
Show Source
Nested Schema : keywords
Type: array
Keywords of product.
Show Source
Nested Schema : largeImage
Type: object
Has repository ID and URL of the product.
Show Source
Nested Schema : listPrices
Type: object
Object with price group IDs as keys and list prices as values
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs.
Show Source
Nested Schema : parentCategories
Type: array
Array having repository ID of the product.
Show Source
Nested Schema : productImages
Type: array
Array of product images.
Show Source
Nested Schema : productImagesMetaData
Type: array
Image Metadata
Show Source
Nested Schema : productVariantOptions
Type: array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : relatedProducts
Type: array
Array of related products.
Show Source
Nested Schema : salePrices
Type: object
Object with price group IDs as keys and sale prices as values
Show Source
Nested Schema : seoMetaInfo
Type: object
Seo meta info for category.
Show Source
Nested Schema : shippingSurcharges
Type: object
Object with price group IDs as keys and shipping surcharges as values
Show Source
Nested Schema : smallImageURLs
Type: array
Small image URL of the product.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source image URL.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of the product.
Show Source
Nested Schema : items
Type: object
AddOn product.
Show Source
Nested Schema : configurationOptions
Type: array
Array of configuration options.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : product
Type: object
Product Details
Show Source
Nested Schema : sku
Type: object
Sku Details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : metadata
Type: object
Seo meta info for product.
Show Source
Nested Schema : tags
Type: array
The array of product image tags
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : optionValueMap
Type: object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childSKUs
Type: array
Array having the properties of child SKU of the product.
Show Source
Nested Schema : defaultProductListingSku
Type: object
Default Product Listing Sku product
Show Source
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Show Source
Nested Schema : keywords
Type: array
Keywords of product.
Show Source
Nested Schema : largeImage
Type: object
Has repository ID and URL of the product.
Show Source
Nested Schema : largeImageURLs
Type: array
Large Image URLs.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : parentCategories
Type: array
Array having repository ID of the product.
Show Source
Nested Schema : productImages
Type: array
Array of product images.
Show Source
Nested Schema : productImagesMetaData
Type: array
Image Metadata
Show Source
Nested Schema : seoMetaInfo
Type: object
Seo meta info for category.
Show Source
Nested Schema : smallImageURLs
Type: array
Small Image URLs.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source Image URLs.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : metadata
Type: object
Seo meta info for product.
Show Source
Nested Schema : tags
Type: array
The array of product image tags
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "dynamicPropertyMapLong":{
    },
    "largeImage":{
        "repositoryId":"m2502",
        "url":"/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
    },
    "keywords":[
        "offers",
        "batteries",
        "traditional",
        "requires",
        "army",
        "fm",
        "life",
        "battery",
        "radio",
        "included",
        "styling",
        "vintage-style",
        "inspired",
        "sounds"
    ],
    "orderable":null,
    "relatedProducts":[
        {
            "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
            "largeImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":"A-Line Skirt",
            "description":"The simple perfect A line",
            "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg",
            "type":"1102",
            "largeImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=940&width=940"
            ],
            "listVolumePrices":{
            },
            "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
            "smallImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300"
            ],
            "id":"xprod2535",
            "brand":"CricketClub",
            "salePriceEndDate":null,
            "clonedFrom":null,
            "childSKUs":[
                {
                    "dynamicPropertyMapLong":{
                        "sku-WomensApparel_color":13,
                        "sku-WomensApparel_size":0
                    },
                    "primaryThumbImageURL":null,
                    "bundleLinks":[
                    ],
                    "largeImage":null,
                    "smallImage":null,
                    "color":"Poppy",
                    "listVolumePrice":null,
                    "nonreturnable":false,
                    "listPrices":{
                        "defaultPriceGroup":55
                    },
                    "primaryFullImageURL":null,
                    "configurationMetadata":[
                    ],
                    "productListingSku":null,
                    "largeImageURLs":[
                    ],
                    "listVolumePrices":{
                    },
                    "primaryLargeImageURL":null,
                    "smallImageURLs":[
                    ],
                    "thumbnailImage":null,
                    "saleVolumePrices":{
                    },
                    "salePriceEndDate":null,
                    "saleVolumePrice":null,
                    "salePriceStartDate":null,
                    "images":[
                    ],
                    "quantity":null,
                    "salePrice":null,
                    "primaryMediumImageURL":null,
                    "fullImageURLs":[
                    ],
                    "active":true,
                    "thumbImageURLs":[
                    ],
                    "size":"Small",
                    "mediumImageURLs":[
                    ],
                    "repositoryId":"xsku2535_1",
                    "shippingSurcharge":null,
                    "primarySourceImageURL":null,
                    "primarySmallImageURL":null,
                    "sourceImageURLs":[
                    ],
                    "listPrice":55
                }
            ],
            "salePriceStartDate":null,
            "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
            "salePrice":null,
            "fullImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg"
            ],
            "active":true,
            "thumbImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=100&width=100"
            ],
            "route":"/a-line-skirt/product/xprod2535",
            "mediumImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=475&width=475"
            ],
            "repositoryId":"xprod2535",
            "shippingSurcharge":null,
            "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
            "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
            "sourceImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300"
            ],
            "listPrice":55
        }
    ],
    "orderLimit":null,
    "onlineOnly":false,
    "listPrices":{
        "UsDollar":69,
        "CaDollar":79
    },
    "type":null,
    "seoMetaInfo":{
        "seoDescription":"Army Radio,FM / AM battery radio with traditional styling",
        "repositoryId":"100002",
        "seoTitle":"Army Radio",
        "seoKeywords":"Army Radio,Radios,For Her",
        "seoUrlSlug":"army-radio"
    },
    "largeImageURLs":[
        "http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=940&width=940"
    ],
    "listVolumePrices":{
    },
    "shippable":true,
    "addOnProducts":[
        {
            "repositoryId":"cp10001",
            "addOnOptions":[
                {
                    "product":{
                        "displayName":"Gift Wrapping",
                        "repositoryId":"prod10005",
                        "active":true
                    },
                    "repositoryId":"co10002",
                    "sku":{
                        "displayName":"Shiny Wrapping Paper",
                        "repositoryId":"sku10006",
                        "active":true
                    }
                },
                {
                    "product":{
                        "displayName":"Gift Wrapping",
                        "repositoryId":"prod10005",
                        "active":true
                    },
                    "repositoryId":"co10003",
                    "sku":{
                        "displayName":"Birthday Wrapping Paper",
                        "repositoryId":"sku10007",
                        "active":true
                    }
                }
            ]
        }
    ],
    "primaryImageAltText":"Army Radio",
    "id":"xprod2046",
    "brand":"Style by\n\t\t\tZhanna",
    "parentCategories":[
        {
            "repositoryId":"cat10020"
        }
    ],
    "salePriceEndDate":null,
    "height":null,
    "defaultProductListingSku":null,
    "assetable":false,
    "primaryMediumImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=475&width=475",
    "seoKeywordsDerived":"Army Radio,Radios,For Her",
    "seoUrlSlugDerived":"army-radio",
    "dynamicPropertyMapBigString":{
    },
    "active":true,
    "weight":null,
    "thumbImageURLs":[
        "http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=100&width=100"
    ],
    "creationDate":"2007-12-04T07:49:42.000Z",
    "taxCode":"PC030100",
    "arrivalDate":null,
    "route":"/army-radio/product/xprod2046",
    "mediumImageURLs":[
        "http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=475&width=475"
    ],
    "parentCategory":{
        "repositoryId":"cat10020"
    },
    "primarySourceImageURL":"http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg",
    "primarySmallImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=300&width=300",
    "sourceImageURLs":[
        "http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
    ],
    "longDescription":"Inspired by life in the army, this\n\t\t\tvintage-style radio offers modern-day sounds. Requires 2 D-cell\n\t\t\tbatteries, not included.",
    "primaryThumbImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=100&width=100",
    "nonreturnable":false,
    "displayName":"Army Radio",
    "seoDescriptionDerived":"Army Radio,FM / AM battery radio with traditional styling",
    "description":"FM / AM battery radio with traditional\n\t\t\tstyling",
    "primaryFullImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg",
    "salePrices":{
        "UsDollar":null,
        "CaDollar":null
    },
    "seoTitleDerived":"Army Radio",
    "primaryLargeImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=940&width=940",
    "smallImageURLs":[
        "http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=300&width=300"
    ],
    "shippingSurcharges":{
        "UsDollar":20,
        "CaDollar":30
    },
    "dynamicPropertyMapString":{
    },
    "discountable":true,
    "saleVolumePrices":{
        "UsDollar":{
            "bulkPrice":{
                "numLevels":3,
                "levels":[
                    {
                        "price":19,
                        "levelMinimum":1,
                        "levelMaximum":5
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            }
        },
        "CaDollar":{
            "bulkPrice":{
                "numLevels":3,
                "levels":[
                    {
                        "price":19,
                        "levelMinimum":1,
                        "levelMaximum":5
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            }
        }
    },
    "childSKUs":[
        {
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "bundleLinks":[
                {
                    "repositoryId":"skul40005"
                }
            ],
            "largeImage":null,
            "smallImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "listPrices":null,
            "salePrices":null,
            "primaryFullImageURL":null,
            "configurationMetadata":[
            ],
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "listVolumePrices":{
            },
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "thumbnailImage":null,
            "saleVolumePrices":{
            },
            "salePriceEndDate":null,
            "saleVolumePrice":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":96,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "repositoryId":"xsku2046",
            "shippingSurcharge":20,
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":69
        }
    ],
    "primaryImageTitle":"Army Radio",
    "saleVolumePrice":{
        "bulkPrice":{
            "numLevels":3,
            "levels":[
                {
                    "price":19,
                    "levelMinimum":1,
                    "levelMaximum":5
                },
                {
                    "price":12.35,
                    "levelMinimum":21,
                    "levelMaximum":30
                },
                {
                    "price":10.25,
                    "levelMinimum":31
                }
            ]
        }
    },
    "salePriceStartDate":null,
    "salePrice":null,
    "fullImageURLs":[
        "http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
    ],
    "length":null,
    "productImagesMetaData":[
        {
            "altText":"Army Radio",
            "titleText":"Army Radio"
        }
    ],
    "productImages":[
        {
            "path":"/products/HOME_ArmyRadio_full.jpg",
            "metadata":{
                "altText":"Army Radio",
                "titleText":"Army Radio"
            },
            "name":"/products/HOME_ArmyRadio_full.jpg",
            "repositoryId":"img_xprod2046_0",
            "url":"http://localhost:9080/file/products/HOME_ArmyRadio_full.jpg",
            "tags":[
            ]
        }
    ],
    "variantValuesOrder":{
        "color":[
            "Spring Green",
            "Cranberry",
            "Marigold"
        ],
        "size":[
            "Small",
            "Large",
            "Medium"
        ]
    },
    "dateAvailable":"2007-12-04T07:49:42.000Z",
    "repositoryId":"xprod2046",
    "width":null,
    "shippingSurcharge":20,
    "daysAvailable":2302,
    "dynamicPropertyMapDouble":{
    },
    "listPrice":69
}

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| |------------------|------------------| |20032|No product id specified on item| |25013|Price List Internal Error| |20030|Get Product Type Internal Error| |20040|Could not get price for product|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top