updateProduct
put
/ccadmin/v1/products/{id}
Update Product. Updates an existing product based on product ID provided,specific properties have to be specified for getting them updated. Can also be used to update product images. **Requires the x-ccasset-language header so translated content can be set for a specific language.**
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
string
Required:true
Product ID corresponding to the product to be updated.
Header Parameters
- X-CCAsset-Language
-
Type:
string
Required:true
The asset language of the request
Body Parameter
Root Schema : updateProduct_request
{
"productImages":[
{
"path":"/products/HOME_AntiqueTableLamp_full.jpg",
"metadata":{
"altText":"Antique Table Lamp",
"titleText":"Antique Table Lamp"
},
"name":"/products/HOME_AntiqueTableLamp_full.jpg",
"url":"http://localhost:9080/file/products/HOME_AntiqueTableLamp_full.jpg",
"tags":[
]
}
],
"variantValuesOrder":{
"color":[
"Spring Green",
"Cranberry"
],
"size":[
"Small",
"Large"
]
},
"properties":{
"longDescription":"A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach. ",
"displayName":"Weekend T-Shirt",
"orderLimit":null,
"description":"A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach. ",
"listPrices":{
"CaDollar":24.99
},
"salePrices":{
"CaDollar":19.99
},
"seoMetaInfo":{
"seoDescription":"Weekend T-Shirt, A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach.",
"seoTitle":"Weekend T-Shirt",
"seoKeywords":"Weekend T-Shirt",
"seoUrlSlug":"weekend-t-shirt"
},
"listVolumePrices":{
"UsDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"shippingSurcharges":{
"UsDollar":1.99,
"CaDollar":4.99
},
"id":"prod10007",
"brand":"StyleForce7",
"saleVolumePrices":{
"UsDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"height":null,
"salePrice":null,
"length":null,
"active":true,
"weight":null,
"taxCode":"PC030100",
"arrivalDate":null,
"notForIndividualSale":true,
"fabric":"Cotton",
"width":null,
"repositoryId":"prod10007",
"shippingSurcharge":null,
"listPrice":19.99,
"fixedRelatedProductIds":[
"xprod2535"
]
}
}
- 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. - productImages
-
Type:
array
productImagesList of product images to assign to the product. - properties
-
Type:
object
propertiesRequired:true
Properties of the product to be created.
Nested Schema : productImages
Nested Schema : properties
Type:
object
Properties of the product to be created.
- active
-
Type:
boolean
Tells whether product is active. - arrivalDate
-
Type:
string
Arrival date of the product. - brand
-
Type:
string
Brand of the product. - CountryOfOrigin
-
Type:
string
Country of origin of the product. - description
-
Type:
string
Description of the product. - displayName
-
Type:
string
Required:true
Display name of the product. - fixedRelatedProductIds
-
Type:
array
fixedRelatedProductIdsThe array of related product ids - height
-
Type:
string
Height of the product. - id
-
Type:
string
Required:true
The id of the product to create. - length
-
Type:
string
Length of the product. - listPrice
-
Type:
number
List price of the product in the default price group. Required if listPrices does not set the price for the default price group. - listVolumePrices
-
Type:
object
listVolumePricesObject with price group IDs as keys and list prices as values - longDescription
-
Type:
string
Long description of the product. - notForIndividualSale
-
Type:
boolean
States whether not a product may be sold individually rather than, for example, as part of a configured product - orderLimit
-
Type:
string
Order limit of the product. - productNumber
-
Type:
string
Required:true
Product number of the product. - salePrice
-
Type:
number
Sale price of the product in the default price group. - saleVolumePrices
-
Type:
object
saleVolumePricesObject with price group IDs as keys and sale prices as values - 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
seoMetaInfoSeo 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 costs while shipping the product, in the default price group. - taxCode
-
Type:
string
Required:true
Tax code of the product. - weight
-
Type:
string
Weight of the product. - width
-
Type:
string
Width of the product.
Nested Schema : items
Type:
object
- metadata
-
Type:
object
metadataSeo meta info for product. - name
-
Type:
string
Image filename without path. - path
-
Type:
string
Virtual path to image, including filename.
Nested Schema : metadata
Type:
object
Seo meta info for product.
- altText
-
Type:
string
Alt text for product image. - titleText
-
Type:
string
Title text for product image.
Nested Schema : fixedRelatedProductIds
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
- priceGroupId1
-
Type:
object
priceGroupId1List price of the product in price group 1 - priceGroupId2
-
Type:
object
priceGroupId2List price of the product in price group 1
Nested Schema : saleVolumePrices
Type:
object
Object with price group IDs as keys and sale prices as values
- priceGroupId1
-
Type:
object
priceGroupId1Sale price of the product in price group 1 - priceGroupId2
-
Type:
object
priceGroupId2Sale price of the product in price group 1
Nested Schema : seoMetaInfo
Type:
object
Seo meta info for category.
- 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 : priceGroupId1
Type:
object
List price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
List price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
Sale price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
Sale price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateProduct_response
- 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
childSKUsArray 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
defaultProductListingSkuDefault 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
fullImageURLsFull Image URLs of SKU. - height
-
Type:
string
Height of the product. - id
-
Type:
string
Product ID. - keywords
-
Type:
array
keywordsKeywords of product. - largeImage
-
Type:
object
largeImageHas repository ID and URL of the product. - largeImageURLs
-
Type:
array
largeImageURLsLarge Image URLs. - length
-
Type:
string
Length of the product. - listPrice
-
Type:
number
List Price of the product in the default price group. - listVolumePrice
-
Type:
object
listVolumePricelist volume price of the product - listVolumePrices
-
Type:
object
listVolumePricesObject with price group IDs as keys and list prices as values - longDescription
-
Type:
string
Long description of the product. - mediumImageURLs
-
Type:
array
mediumImageURLsMedium 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
parentCategoriesArray 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
productImagesArray of product images. - productImagesMetaData
-
Type:
array
productImagesMetaDataImage Metadata - relatedProducts
-
Type:
array
relatedProductsArray 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. - salePriceStartDate
-
Type:
string
Sale Price Start Date of the product. - saleVolumePrice
-
Type:
object
saleVolumePriceSale volume price of the product - saleVolumePrices
-
Type:
object
saleVolumePricesObject with price group IDs as keys and sale volume prices as values - 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
seoMetaInfoSeo 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
smallImageURLsSmall Image URLs. - sourceImageURLs
-
Type:
array
sourceImageURLsSource Image URLs. - taxCode
-
Type:
string
Tax Code of the product. - thumbImageURLs
-
Type:
array
thumbImageURLsThumb 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
Nested Schema : defaultProductListingSku
Nested Schema : fullImageURLs
Nested Schema : keywords
Nested Schema : largeImage
Type:
object
Has repository ID and URL of the product.
- id
-
Type:
string
Repository ID - url
-
Type:
string
Repository URL
Nested Schema : largeImageURLs
Nested Schema : listVolumePrice
Type:
object
list volume price of the product
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
- priceGroupId1
-
Type:
object
priceGroupId1List price of the product in price group 1 - priceGroupId2
-
Type:
object
priceGroupId2List price of the product in price group 1
Nested Schema : mediumImageURLs
Nested Schema : parentCategories
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the product
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
object
Object with price group IDs as keys and sale volume prices as values
- priceGroupId1
-
Type:
object
priceGroupId1Sale price of the product in price group 1 - priceGroupId2
-
Type:
object
priceGroupId2Sale price of the product in price group 1
Nested Schema : seoMetaInfo
Type:
object
Seo meta info for category.
- 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
Nested Schema : sourceImageURLs
Nested Schema : thumbImageURLs
Nested Schema : items
Type:
object
- active
-
Type:
boolean
Indicates whether sku is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true. - bundleLinks
-
Type:
array
bundleLinksArray of bundle links associated with the SKU - dynamicPropertyMapLong
-
Type:
string
Dynamic Property MapLong of SKU. - fullImageURLs
-
Type:
array
fullImageURLsFull Image URLs of SKU. - largeImage
-
Type:
string
Large Image of the SKU. - largeImageURLs
-
Type:
array
largeImageURLsLarge Image URLs of SKU. - listPrice
-
Type:
number
List Price of the product SKU. - listVolumePrice
-
Type:
object
listVolumePricelist volume price of the sku - mediumImageURLs
-
Type:
array
mediumImageURLsMedium 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. - saleVolumePrice
-
Type:
object
saleVolumePriceSale volume price of the sku - shippingSurcharge
-
Type:
number
Extra handling cost while shipping the product. - smallImage
-
Type:
string
Small Image URL of SKU. - smallImageURLs
-
Type:
array
smallImageURLsSmall Image URLs of SKU. - sourceImageURLs
-
Type:
array
sourceImageURLsSource Image URLs of SKU. - thumbImageURLs
-
Type:
array
thumbImageURLsThumb Image URLs of SKU. - thumbnailImage
-
Type:
string
Thumbnail Image of SKU.
Nested Schema : bundleLinks
Nested Schema : fullImageURLs
Nested Schema : largeImageURLs
Nested Schema : listVolumePrice
Type:
object
list volume price of the sku
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : mediumImageURLs
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the sku
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : smallImageURLs
Nested Schema : sourceImageURLs
Nested Schema : thumbImageURLs
Nested Schema : items
Type:
object
- repositoryId
-
Type:
string
The id of the bundle link
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
List price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
List price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : items
Type:
object
- repositoryId
-
Type:
string
Repository ID of product.
Nested Schema : items
Type:
object
- metadata
-
Type:
object
metadataSeo 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
tagsThe array of product image tags - url
-
Type:
string
The url of the product image
Nested Schema : metadata
Type:
object
Seo meta info for product.
- altText
-
Type:
string
The alt text of the image - titleText
-
Type:
string
The title text of the image
Nested Schema : items
Type:
object
- altText
-
Type:
string
Alt text for product image. - titleText
-
Type:
string
Title text for product image.
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
Sale price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
Sale price of the product in price group 1
- pricingScheme
-
Type:
object
pricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
array
levelsPrice levels array for volume price - numLevels
-
Type:
number
Number of levels in the volume price
Nested Schema : items
Type:
object
- levelMaximum
-
Type:
number
minimum quantity for price level - levelMinimum
-
Type:
number
minimum quantity for price level - price
-
Type:
number
price value for price level
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"
],
"listVolumePrice":null,
"orderable":null,
"relatedProducts":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
"largeImage":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"
],
"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",
"primaryFullImageURL":null,
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"thumbnailImage":null,
"salePriceEndDate":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":{
},
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
{
"repositoryId":"skul40005"
}
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"primaryFullImageURL":null,
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"thumbnailImage":null,
"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":null,
"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|
|------------------|------------------|
|20013|Cannot find product for product Id|
|20012|No product id specified on item|
|20011|Null Properties Type Internal Error|
|20010|update Product Type Internal Error|
|20032|No product id specified on item|
|20018|Invalid product ID, Product ID may only contain alphanumeric characters|
|25009|Cannot find product for product Id|
|25001|Price is invalid|
|20001|Null Properties Type Internal Error|
|20000|create Product Type Internal Error|
|20141|Collection Id passed is null or empty|
|25015|set PropertyR epositoryItem Internal Error|
|26104|Could not find the specified parent folder|
|25014|convert Input Property Internal Error|
|26103|Could not assign the list of product images to the product|
|26105|No product image list was provided|
|20502|There was an error while retrieving seo metadata from repository.|
|20006|{0} of a product must be unique. {1} is already in use|
|20204|Cannot assign the product as it's own related product|
|25011|Sale price must be a positive number or 0|
|26100|Update Product Images Type Internal Error|
|26102|Could not add the image to the list of product images|
|25012|List price must be greater than the sale price|
|26101|Could not locate the product by the repository ID provided|
|20040|Could not get price for product {0}|
|10003|validate Create Item Type Internal Error|
Body
Root Schema : errorModel
Type:
object
- 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
errorsAn 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
Nested Schema : items
Type:
object
- 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 Request:
{ "productImages": [{ "path": "/products/HOME_AntiqueTableLamp_full.jpg", "metadata": { "altText": "Antique Table Lamp", "titleText": "Antique Table Lamp" }, "name": "/products/HOME_AntiqueTableLamp_full.jpg", "url": "http://localhost:9080/file/products/HOME_AntiqueTableLamp_full.jpg", "tags": [] }], "variantValuesOrder": { "color": [ "Spring Green", "Cranberry" ], "size": [ "Small", "Large" ] }, "properties": { "longDescription": "A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach. ", "displayName": "Weekend T-Shirt", "orderLimit": null, "description": "A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach. ", "listPrices": {"CaDollar": 24.99}, "salePrices": {"CaDollar": 19.99}, "seoMetaInfo": { "seoDescription": "Weekend T-Shirt, A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach.", "seoTitle": "Weekend T-Shirt", "seoKeywords": "Weekend T-Shirt", "seoUrlSlug": "weekend-t-shirt" }, "listVolumePrices": {"UsDollar": {"bulkPrice": { "numLevels": 3, "levels": [ { "price": 19, "levelMinimum": 1, "levelMaximum": 5 }, { "price": 12.35, "levelMinimum": 21, "levelMaximum": 30 }, { "price": 10.25, "levelMinimum": 31 } ] }}}, "shippingSurcharges": { "UsDollar": 1.99, "CaDollar": 4.99 }, "id": "prod10007", "brand": "StyleForce7", "saleVolumePrices": {"UsDollar": {"bulkPrice": { "numLevels": 3, "levels": [ { "price": 19, "levelMinimum": 1, "levelMaximum": 5 }, { "price": 12.35, "levelMinimum": 21, "levelMaximum": 30 }, { "price": 10.25, "levelMinimum": 31 } ] }}}, "height": null, "salePrice": null, "length": null, "active": true, "weight": null, "taxCode": "PC030100", "arrivalDate": null, "notForIndividualSale": true, "fabric": "Cotton", "width": null, "repositoryId": "prod10007", "shippingSurcharge": null, "listPrice": 19.99, "fixedRelatedProductIds": ["xprod2535"] } }
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" ], "listVolumePrice": null, "orderable": null, "relatedProducts": [{ "primaryThumbImageURL": "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=100&width=100", "largeImage": 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"], "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", "primaryFullImageURL": null, "productListingSku": null, "largeImageURLs": [], "primaryLargeImageURL": null, "smallImageURLs": [], "thumbnailImage": null, "salePriceEndDate": 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": {}, "childSKUs": [{ "dynamicPropertyMapLong": {}, "primaryThumbImageURL": null, "bundleLinks": [{"repositoryId": "skul40005"}], "largeImage": null, "smallImage": null, "listVolumePrice": null, "primaryFullImageURL": null, "productListingSku": null, "largeImageURLs": [], "primaryLargeImageURL": null, "smallImageURLs": [], "thumbnailImage": null, "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": null, "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 }