1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Store
  4. Products

getProduct

get

/ccstore/v1/products/{id}

Get Product. Get a product. Optionally takes the x-ccasset-language headers to get translated content in another language.Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization id of logged in user.None of the image URLS are encoded.

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
The array of add-on product groups
Show Source
Nested Schema : childSKUs
Type: array
List of SKU's for the product
Show Source
Nested Schema : fullImageURLs
Type: array
full image url paths.The urls are not encoded.
Show Source
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
medium image urls path. The urls are not encoded.
Show Source
Nested Schema : productVariantOptions
Type: array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Show Source
Nested Schema : smallImageURLs
Type: array
small image url paths. The urls are not encoded.
Show Source
Nested Schema : sourceImageURLs
Type: array
source image urls of the product. The urls are not encoded.
Show Source
Nested Schema : thumbImageURLs
Type: array
thumb image urls of the product. The urls are not encoded.
Show Source
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : addOnOptions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : product
Type: object
The add-on product
Show Source
Nested Schema : sku
Type: object
The add-on sku
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 : listPrices
Type: object
list prices of the SKU in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the SKU in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
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 : optionValueMap
Type: object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
Example Response (application/json)
{
    "dynamicPropertyMapLong":{
    },
    "largeImage":null,
    "smallImage":null,
    "upsellProductGroup":null,
    "keywords":[
    ],
    "endDate":null,
    "derivedCatalogs":[
    ],
    "custRatingCount":null,
    "orderable":null,
    "relatedProducts":null,
    "orderLimit":null,
    "onlineOnly":false,
    "listPrices":null,
    "dynamicUpsellProducts":null,
    "type":null,
    "largeImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940"
    ],
    "ancestorCategoryIds":[
    ],
    "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
                    }
                }
            ]
        }
    ],
    "derivedSalePriceFrom":"defaultPriceGroup",
    "productInfos":{
    },
    "id":"xprod2119",
    "brand":"Fisher's Colony",
    "salePriceEndDate":null,
    "height":null,
    "defaultProductListingSku":null,
    "assetable":false,
    "primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475",
    "skuOptionsInfo":null,
    "seoUrlSlugDerived":"vineyard-antique-arm-chair",
    "dynamicPropertyMapBigString":{
    },
    "active":true,
    "weight":null,
    "thumbImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100"
    ],
    "taxCode":"PC030100",
    "creationDate":"2014-10-27T05:11:57.034Z",
    "version":2,
    "parentCategoryIdPath":null,
    "arrivalDate":null,
    "route":"/vineyard-antique-arm-chair/product/xprod2119",
    "catalogs":[
    ],
    "mediumImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=475&width=475"
    ],
    "primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
    "parentCategory":null,
    "primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300",
    "sourceImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
    ],
    "avgCustRating":null,
    "startDate":null,
    "longDescription":"This 18th century antique reproduction arm chair features hand-carved walnut and spring cushion base. Upholstered in buttery soft print textile with a lovely vintage pattern.",
    "template":null,
    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=100&width=100",
    "nonreturnable":false,
    "displayName":"Vineyard Antique Arm Chair",
    "description":"Hand-carved walnut",
    "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg",
    "salePrices":null,
    "productVariantOptions":[
        {
            "listingVariant":false,
            "optionValueMap":{
                "Silver":1,
                "Neon":2,
                "Black":0
            },
            "variantBasedDisplay":false,
            "optionId":"color",
            "mapKeyPropertyAttribute":"sku-camcorder_color",
            "optionName":"color"
        }
    ],
    "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=940&width=940",
    "derivedShippingSurchargeFrom":"defaultPriceGroup",
    "smallImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg&height=300&width=300"
    ],
    "itemAcl":null,
    "shippingSurcharges":null,
    "displayableSkuAttributes":[
    ],
    "dynamicPropertyMapString":{
    },
    "siteIds":[
    ],
    "thumbnailImage":null,
    "discountable":true,
    "computedCatalogs":[
    ],
    "childSKUs":[
        {
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "largeImage":null,
            "smallImage":null,
            "nonreturnable":false,
            "listPrices":null,
            "salePrices":null,
            "primaryFullImageURL":null,
            "configurationMetadata":[
            ],
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "primaryLargeImageURL":null,
            "derivedOnlineOnly":true,
            "smallImageURLs":[
            ],
            "derivedSalePriceFrom":"defaultPriceGroup",
            "shippingSurcharges":null,
            "thumbnailImage":null,
            "salePriceEndDate":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "active":true,
            "thumbImageURLs":[
            ],
            "mediumImageURLs":[
            ],
            "derivedListPriceFrom":"defaultPriceGroup",
            "repositoryId":"xsku2119",
            "DynamicSkuProperty2":"value2",
            "shippingSurcharge":null,
            "DynamicSkuProperty1":"value1",
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":219
        }
    ],
    "salePriceStartDate":null,
    "catalogsRelatedProducts":[
    ],
    "fixedRelatedProducts":[
    ],
    "salePrice":null,
    "fullImageURLs":[
        "/ccstore/v1/images/?source=http://localhost:8080/file/cloudlakeimages/products/full/ST_VineyardAntiqueChair_full.jpg"
    ],
    "length":null,
    "upsellProducts":null,
    "variantValuesOrder":{
        "color":[
            "Spring Green",
            "Cranberry",
            "Marigold"
        ],
        "size":[
            "Small",
            "Large",
            "Medium"
        ]
    },
    "relatedProductGroup":null,
    "auxiliaryMedia":{
    },
    "dateAvailable":"2014-10-27T05:11:57.034Z",
    "derivedListPriceFrom":"defaultPriceGroup",
    "width":null,
    "repositoryId":"xprod2119",
    "shippingSurcharge":null,
    "ancestorCategories":[
    ],
    "daysAvailable":0,
    "dynamicPropertyMapDouble":{
    },
    "listPrice":219,
    "dynamicRelatedProducts":null,
    "fixedUpsellProducts":[
    ]
}

Default Response

The error response
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