Oracle Commerce Cloud October 2017

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

application/json

Path Parameters

id: Type: string

Required: true

ID corresponding to the product to be fetched.

Query Parameters

includePrices: Type: boolean

Boolean flag to determine whether to include price maps for the products in the response.
priceListGroupId: Type: string

Price list group id for adding the prices to the product in the response.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getProduct_response

Properties

active: Type: boolean

Tells whether product is active.
arrivalDate: Type: string

Arrival date of product.
brand: Type: string

Brand of the product.
childSKUs: Type: array childSKUs

Array having the properties of child SKU of the product.
creationDate: Type: string

Creation Date of the product.
dateAvailable: Type: string

Date Available of the product.
daysAvailable: Type: integer

Days Available of the product.
defaultProductListingSku: Type: object defaultProductListingSku

Default Product Listing Sku product
description: Type: string

Description of the product.
displayName: Type: string

Display Name of the product.
dynamicPropertyMapDouble: Type: string

Dynamic property map double.
dynamicPropertyMapLong: Type: string

Dynamic Property Map Long.
dynamicPropertyMapString: Type: string

Dynamic Property MapString.
fullImageURLs: Type: string

Full image URL of the product.
height: Type: string

Height of the product.
id: Type: string

Product ID.
keywords: Type: array keywords

Keywords of product.
largeImage: Type: object largeImage

Has repository ID and URL of the product.
largeImageURLs: Type: string

Large Image URLs of the product.
length: Type: string

Length of the product.
listPrice: Type: number

List Price of the product in the default price group.
listPrices: Type: object listPrices

Object with price group IDs as keys and list prices as values
longDescription: Type: string

Long description of the product.
mediumImageURLs: Type: array mediumImageURLs

Medium Image URLs.
notForIndividualSale: Type: boolean

States whether not a product may be sold individually rather than, for example, as part of a configured product
onlineOnly: Type: boolean

Tells whether the product is online.
orderable: Type: string

Whether product is orderable.
orderLimit: Type: string

Order limit of the product.
parentCategories: Type: array parentCategories

Array having repository ID of the product.
parentCategory: Type: string

Parent category of the product.
primaryFullImageURL: Type: string

Primary full image URL of the product.
primaryImageAltText: Type: string

Alt text for product primary image.
primaryImageTitle: Type: string

Title text for product primary image.
primaryLargeImageURL: Type: string

Primary large image URL of the product.
primaryMediumImageURL: Type: string

Primary Medium Image URL.
primarySmallImageURL: Type: string

Primary Small Image URL of the product.
primarySourceImageURL: Type: string

Primary Source Image URL of the product.
primaryThumbImageURL: Type: string

Primary Thumb Image URL of the product.
productImages: Type: array productImages

Array of product images.
productImagesMetaData: Type: array productImagesMetaData

Image Metadata
productNumber: Type: string

Product number.
relatedProducts: Type: array relatedProducts

Array of related products.
repositoryId: Type: string

Repository ID of the product.
route: Type: string

Route of the product.
salePrice: Type: number

Sale Price of the product in the default price group.
salePriceEndDate: Type: string

Sale Price End Date of the product.
salePrices: Type: object salePrices

Object with price group IDs as keys and sale prices as values
salePriceStartDate: Type: string

Sale Price Start Date of the product.
seoDescriptionDerived: Type: string

Derived from display name and description of the product
seoKeywordsDerived: Type: string

Derived from display name and ancestor category name's of the product
seoMetaInfo: Type: object seoMetaInfo

Seo meta info for category.
seoTitleDerived: Type: string

Derived from display name of the product
shippingSurcharge: Type: number

Extra handling cost for shipping the product in the default price group.
shippingSurcharges: Type: object shippingSurcharges

Object with price group IDs as keys and shipping surcharges as values
smallImageURLs: Type: array smallImageURLs

Small image URL of the product.
sourceImageURLs: Type: array sourceImageURLs

Source image URL.
taxCode: Type: string

Tax Code of the product.
thumbImageURLs: Type: array thumbImageURLs

Thumb Image URLs of the product.
translations: Type: string

Translations of the product.
type: Type: string

Type of product.
weight: Type: string

Weight of the product.
width: Type: string

Width of the product.

Nested Schema : childSKUs

Type: array

Array having the properties of child SKU of the product.

Items

Type: object items

Nested Schema : defaultProductListingSku

Type: object

Default Product Listing Sku product

Properties

id: Type: string

Repository ID

Nested Schema : keywords

Type: array

Keywords of product.

Items

Type: string

Nested Schema : largeImage

Type: object

Has repository ID and URL of the product.

Properties

id: Type: string

Repository ID
url: Type: string

Repository URL

Nested Schema : listPrices

Type: object

Object with price group IDs as keys and list prices as values

Properties

Price Group ID 1: Type: number

List price of the product in price group 1
Price Group ID 2: Type: number

List price of the product in price group 2

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs.

Items

Type: string

Nested Schema : parentCategories

Type: array

Array having repository ID of the product.

Items

Type: object items

Nested Schema : productImages

Type: array

Array of product images.

Items

Type: object items

Nested Schema : productImagesMetaData

Type: array

Image Metadata

Items

Type: object items

Nested Schema : relatedProducts

Type: array

Array of related products.

Items

Type: object items

Nested Schema : salePrices

Type: object

Object with price group IDs as keys and sale prices as values

Properties

Price Group ID 1: Type: number

Sale price of the product in price group 1
Price Group ID 2: Type: number

Sale price of the product in price group 2

Nested Schema : seoMetaInfo

Type: object

Seo meta info for category.

Properties

repositoryId: Type: string

Repository id of seo metadata.
seoDescription: Type: string

Description of category.
seoKeywords: Type: string

Keywords of category.
seoTitle: Type: string

Title of category.

Nested Schema : shippingSurcharges

Type: object

Object with price group IDs as keys and shipping surcharges as values

Properties

Price Group ID 1: Type: number

Shipping surcharge of the product in price group 1
Price Group ID 2: Type: number

Shipping surcharge of the product in price group 2

Nested Schema : smallImageURLs

Type: array

Small image URL of the product.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source image URL.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb Image URLs of the product.

Items

Type: string

Nested Schema : items

Type: object

Properties

dynamicPropertyMapLong: Type: string

Dynamic Property MapLong of SKU.
DynamicSKUProperty: Type: string

Dynamic Properties of SKU.
fullImageURLs: Type: array fullImageURLs

Full Image URLs of SKU.
id: Type: string

SKU id
largeImage: Type: string

Large Image of the SKU.
largeImageURLs: Type: array largeImageURLs

Large Image URLs of SKU.
listPrice: Type: integer

List Price of the product SKU.
mediumImageURLs: Type: array mediumImageURLs

Medium Image URLs SKU.
primaryLargeImageURL: Type: string

Primary Large Image URL of SKU.
primaryMediumImageURL: Type: string

Primary Medium Image URL ID of SKU.
primarySmallImageURL: Type: string

Primary Small Image URL of SKU.
primarySourceImageURL: Type: string

Primary Source Image URL of SKU.
primaryThumbImageURL: Type: string

Primary Source Image URL of SKU.
quantity: Type: integer

Quantity available of SKU.
repositoryId: Type: string

Repository ID of SKU.
salePrice: Type: string

Sale Price of SKU.
salePriceEndDate: Type: string

Sale Price End Date of the SKU.
salePriceStartDate: Type: string

Sale Price Start Date of SKU.
shippingSurcharge: Type: integer

Extra handling cost while shipping the product.
smallImage: Type: string

Small Image URL of SKU.
smallImageURLs: Type: array smallImageURLs

Small Image URLs of SKU.
sourceImageURLs: Type: array sourceImageURLs

Source Image URLs of SKU.
thumbImageURLs: Type: array thumbImageURLs

Thumb Image URLs of SKU.
thumbnailImage: Type: string

Thumbnail Image of SKU.

Nested Schema : fullImageURLs

Type: array

Full Image URLs of SKU.

Items

Type: string

Nested Schema : largeImageURLs

Type: array

Large Image URLs of SKU.

Items

Type: string

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs SKU.

Items

Type: string

Nested Schema : smallImageURLs

Type: array

Small Image URLs of SKU.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source Image URLs of SKU.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb Image URLs of SKU.

Items

Type: string

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository ID of product.

Nested Schema : items

Type: object

Properties

metadata: Type: object metadata

Seo meta info for product.
name: Type: string

The name of product image
path: Type: string

The path of the image
repositoryId: Type: string

The repository Id of the product image
tags: Type: array tags

The array of product image tags
url: Type: string

The url of the product image

Nested Schema : metadata

Type: object

Seo meta info for product.

Properties

altText: Type: string

The alt text of the image
titleText: Type: string

The title text of the image

Nested Schema : tags

Type: array

The array of product image tags

Items

Type: string

Nested Schema : items

Type: object

Properties

altText: Type: string

Alt text for product image.
titleText: Type: string

Title text for product image.

Nested Schema : items

Type: object

Properties

active: Type: boolean

Tells whether product is active.
arrivalDate: Type: string

Arrival date of product.
brand: Type: string

Brand of the product.
childSKUs: Type: array childSKUs

Array having the properties of child SKU of the product.
CountryOfOrigin: Type: string

Country of origin of the product.
creationDate: Type: string

Creation Date of the product.
dateAvailable: Type: string

Date Available of the product.
daysAvailable: Type: integer

Days Available of the product.
defaultProductListingSku: Type: object defaultProductListingSku

Default Product Listing Sku product
description: Type: string

Description of the product.
displayName: Type: string

Display Name of the product.
dynamicPropertyMapBigString: Type: string

Dynamic Property MapBigString.
dynamicPropertyMapDouble: Type: string

Dynamic property map double.
dynamicPropertyMapLong: Type: string

Dynamic Property Map Long.
dynamicPropertyMapString: Type: string

Dynamic Property MapString.
fullImageURLs: Type: array fullImageURLs

Full Image URLs of SKU.
height: Type: string

Height of the product.
id: Type: string

Product ID.
keywords: Type: array keywords

Keywords of product.
largeImage: Type: object largeImage

Has repository ID and URL of the product.
largeImageURLs: Type: array largeImageURLs

Large Image URLs.
length: Type: string

Length of the product.
listPrice: Type: number

List Price of the product in the default price group.
longDescription: Type: string

Long description of the product.
mediumImageURLs: Type: array mediumImageURLs

Medium Image URLs SKU.
notForIndividualSale: Type: boolean

States whether not a product may be sold individually rather than, for example, as part of a configured product
onlineOnly: Type: boolean

Tells whether the product is online.
orderable: Type: string

Whether product is orderable.
orderLimit: Type: string

Order limit of the product.
parentCategories: Type: array parentCategories

Array having repository ID of the product.
parentCategory: Type: string

Parent category of the product.
primaryFullImageURL: Type: string

Primary full image URL of the product.
primaryImageAltText: Type: string

Alt text for product primary image.
primaryImageTitle: Type: string

Title text for product primary image.
primaryLargeImageURL: Type: string

Primary large image URL of the product.
primaryMediumImageURL: Type: string

Primary Medium Image URL.
primarySmallImageURL: Type: string

Primary Small Image URL of the product.
primarySourceImageURL: Type: string

Primary Source Image URL of the product.
primaryThumbImageURL: Type: string

Primary Thumb Image URL of the product.
productImages: Type: array productImages

Array of product images.
productImagesMetaData: Type: array productImagesMetaData

Image Metadata
repositoryId: Type: string

Repository ID of the product.
route: Type: string

Route of the product.
salePrice: Type: number

Sale Price of the product in the default price group.
salePriceEndDate: Type: string

Sale Price End Date of the product.
salePriceStartDate: Type: string

Sale Price Start Date of the product.
seoDescriptionDerived: Type: string

Derived from display name and description of the product
seoKeywordsDerived: Type: string

Derived from display name and ancestor category name's of the product
seoMetaInfo: Type: object seoMetaInfo

Seo meta info for category.
seoTitleDerived: Type: string

Derived from display name of the product
seoUrlSlugDerived: Type: string

Derived from seoUrlSlug of the product if available, else derived from display name of the product
shippingSurcharge: Type: number

Extra handling cost for shipping the product in the default price group.
smallImageURLs: Type: array smallImageURLs

Small Image URLs.
sourceImageURLs: Type: array sourceImageURLs

Source Image URLs.
taxCode: Type: string

Tax Code of the product.
thumbImageURLs: Type: array thumbImageURLs

Thumb Image URLs of the product.
type: Type: string

Type of product.
weight: Type: string

Weight of the product.
width: Type: string

Width of the product.

Nested Schema : childSKUs

Type: array

Array having the properties of child SKU of the product.

Items

Type: object items

Nested Schema : defaultProductListingSku

Type: object

Default Product Listing Sku product

Properties

id: Type: string

Repository ID

Nested Schema : fullImageURLs

Type: array

Full Image URLs of SKU.

Items

Type: string

Nested Schema : keywords

Type: array

Keywords of product.

Items

Type: string

Nested Schema : largeImage

Type: object

Has repository ID and URL of the product.

Properties

id: Type: string

Repository ID
url: Type: string

Repository URL

Nested Schema : largeImageURLs

Type: array

Large Image URLs.

Items

Type: string

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs SKU.

Items

Type: string

Nested Schema : parentCategories

Type: array

Array having repository ID of the product.

Items

Type: object items

Nested Schema : productImages

Type: array

Array of product images.

Items

Type: object items

Nested Schema : productImagesMetaData

Type: array

Image Metadata

Items

Type: object items

Nested Schema : seoMetaInfo

Type: object

Seo meta info for category.

Properties

repositoryId: Type: string

Repository id of seo metadata.
seoDescription: Type: string

Description of product.
seoKeywords: Type: string

Keywords of product.
seoTitle: Type: string

Title of product.
seoUrlSlug: Type: string

Url Slug of product.

Nested Schema : smallImageURLs

Type: array

Small Image URLs.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source Image URLs.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb Image URLs of the product.

Items

Type: string

Nested Schema : items

Type: object

Properties

active: Type: boolean

Indicates whether sku is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
dynamicPropertyMapLong: Type: string

Dynamic Property MapLong of SKU.
fullImageURLs: Type: array fullImageURLs

Full Image URLs of SKU.
largeImage: Type: string

Large Image of the SKU.
largeImageURLs: Type: array largeImageURLs

Large Image URLs of SKU.
listPrice: Type: number

List Price of the product SKU.
mediumImageURLs: Type: array mediumImageURLs

Medium Image URLs SKU.
primaryLargeImageURL: Type: string

Primary Large Image URL of SKU.
primaryMediumImageURL: Type: string

Primary Medium Image URL ID of SKU.
primarySmallImageURL: Type: string

Primary Small Image URL of SKU.
primarySourceImageURL: Type: string

Primary Source Image URL of SKU.
primaryThumbImageURL: Type: string

Primary Source Image URL of SKU.
quantity: Type: integer

Quantity available of SKU.
repositoryId: Type: string

Repository ID of SKU.
salePrice: Type: string

Sale Price of SKU.
salePriceEndDate: Type: string

Sale Price End Date of the SKU.
salePriceStartDate: Type: string

Sale Price Start Date of SKU.
shippingSurcharge: Type: number

Extra handling cost while shipping the product.
smallImage: Type: string

Small Image URL of SKU.
smallImageURLs: Type: array smallImageURLs

Small Image URLs of SKU.
sourceImageURLs: Type: array sourceImageURLs

Source Image URLs of SKU.
thumbImageURLs: Type: array thumbImageURLs

Thumb Image URLs of SKU.
thumbnailImage: Type: string

Thumbnail Image of SKU.

Nested Schema : fullImageURLs

Type: array

Full Image URLs of SKU.

Items

Type: string

Nested Schema : largeImageURLs

Type: array

Large Image URLs of SKU.

Items

Type: string

Nested Schema : mediumImageURLs

Type: array

Medium Image URLs SKU.

Items

Type: string

Nested Schema : smallImageURLs

Type: array

Small Image URLs of SKU.

Items

Type: string

Nested Schema : sourceImageURLs

Type: array

Source Image URLs of SKU.

Items

Type: string

Nested Schema : thumbImageURLs

Type: array

Thumb Image URLs of SKU.

Items

Type: string

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository ID of product.

Nested Schema : items

Type: object

Properties

metadata: Type: object metadata

Seo meta info for product.
name: Type: string

The name of product image
path: Type: string

The path of the image
repositoryId: Type: string

The repository Id of the product image
tags: Type: array tags

The array of product image tags
url: Type: string

The url of the product image

Nested Schema : metadata

Type: object

Seo meta info for product.

Properties

altText: Type: string

The alt text of the image
titleText: Type: string

The title text of the image

Nested Schema : tags

Type: array

The array of product image tags

Items

Type: string

Nested Schema : items

Type: object

Properties

altText: Type: string

Alt text for product image.
titleText: Type: string

Title text for product image.

Example 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,
            "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,
                    "listPrices":{
                        "defaultPriceGroup":55
                    },
                    "primaryFullImageURL":null,
                    "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":{
    },
    "primaryImageAltText":"Army Radio",
    "id":"xprod2046",
    "brand":"Style by\n\t\t\tZhanna",
    "parentCategories":[
        {
            "repositoryId":"cat10020"
        }
    ],
    "salePriceEndDate":null,
    "height":null,
    "defaultProductListingSku":null,
    "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":null,
    "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",
    "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":{
    },
    "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,
            "listPrices":null,
            "salePrices":null,
            "primaryFullImageURL":null,
            "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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,
    "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,
      "listPrices": {"defaultPriceGroup": 55},
      "primaryFullImageURL": null,
      "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": {},
  "primaryImageAltText": "Army Radio",
  "id": "xprod2046",
  "brand": "Style by\n\t\t\tZhanna",
  "parentCategories": [{"repositoryId": "cat10020"}],
  "salePriceEndDate": null,
  "height": null,
  "defaultProductListingSku": null,
  "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": null,
  "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",
  "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": {},
  "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,
    "listPrices": null,
    "salePrices": null,
    "primaryFullImageURL": null,
    "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
}