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: string
Product ID corresponding to the product to be updated.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : updateProduct_request
Type:
Show Source
object
-
catalogId(optional):
string
ID of the catalog.
-
discountable(optional):
boolean
Indicates whether the promotions should be applied to this SKU or not. If the value is true then promotion discounts can be applied to this SKU; else no promotions can be applied to this SKU. Default value is true
-
includePrices(optional):
boolean
Boolean flag to determine whether to include price maps for the products in the response.
-
priceListGroupId(optional):
string
Price list group id for adding the prices to the product in the response.
-
productImages(optional):
array productImages
List of product images to assign to the product.
-
properties:
object properties
Properties of the product to be created.
Example:
{
"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"
]
},
"catalogId":"cloudLakeCatalog",
"properties":{
"longDescription":"A versatile layering piece, this ultra-soft t-shirt is perfect at the city, mountains or beach. ",
"nonreturnable":false,
"directCatalogs":[
"cloudLakeCatalog"
],
"displayName":"Weekend T-Shirt",
"parentCategoryScope":"global",
"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
}
]
}
}
},
"shippable":true,
"addOnProducts":[
{
"repositoryId":"cp10001",
"addOnOptions":[
{
"product":"prod10005",
"repositoryId":"co10002",
"sku":"sku10006"
},
{
"product":"prod10005",
"repositoryId":"co10003",
"sku":"sku10007"
}
]
}
],
"shippingSurcharges":{
"UsDollar":1.99,
"CaDollar":4.99
},
"id":"prod10007",
"discountable":true,
"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",
"parentCategory":"topLeaf",
"shippingSurcharge":null,
"listPrice":19.99,
"fixedRelatedProductIds":[
"xprod2535"
]
}
}
Nested Schema : productImages
Type:
array
List of product images to assign to the product.
Show Source
Nested Schema : properties
Type:
object
Properties of the product to be created.
Show Source
-
active(optional):
boolean
Tells whether product is active.
-
addOnProducts(optional):
array addOnProducts
The array of add-on product groups
-
arrivalDate(optional):
string
Arrival date of the product.
-
brand(optional):
string
Brand of the product.
-
coreProduct(optional):
boolean
Flag specifying if this is a core product that should automatically be a member of filtered view catalogs (unless specifically excluded). Note, changing the core product state of a product will reset the filtered catalogs property of that product.
-
CountryOfOrigin(optional):
string
Country of origin of the product.
-
description(optional):
string
Description of the product.
-
directCatalogs(optional):
array directCatalogs
List of catalog IDs that this product is associated with through direct catalog linking.
-
displayName:
string
Display name of the product.
-
filteredCatalogs(optional):
array filteredCatalogs
List of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
-
fixedRelatedProductIds(optional):
array fixedRelatedProductIds
The array of related product ids
-
height(optional):
string
Height of the product.
-
id:
string
The id of the product to create.
-
length(optional):
string
Length of the product.
-
listPrice(optional):
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(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values
-
longDescription(optional):
string
Long description of the product.
-
nonreturnable(optional):
boolean
Indicates whether the product is returnable or not.
-
notForIndividualSale(optional):
boolean
States whether not a product may be sold individually rather than, for example, as part of a configured product
-
orderLimit(optional):
string
Order limit of the product.
-
parentCategory(optional):
string
Repository id of the default parent category
-
parentCategoryScope(optional):
string
Scope of update for parent category, one of: base, catalogSpecific, global or revertToBase. If this field is not provided then existing scope is used, i.e. if a catalog specific parent category is already set then it will be updated otherwise the base will be updated.
-
productNumber:
string
Product number of the product.
-
salePrice(optional):
number
Sale price of the product in the default price group.
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale prices as values
-
seoDescriptionDerived(optional):
string
Derived from display name and description of the product
-
seoKeywordsDerived(optional):
string
Derived from display name and ancestor category name's of the product
-
seoMetaInfo(optional):
object seoMetaInfo
Seo meta info for category.
-
seoTitleDerived(optional):
string
Derived from display name of the product
-
seoUrlSlugDerived(optional):
string
Derived from seoUrlSlug of the product if available, else derived from display name of the product
-
shippable(optional):
boolean
Indicates whether the product is goods(shippable=true) or services(shippable=false).
-
shippingSurcharge(optional):
number
Extra handling costs while shipping the product, in the default price group.
-
taxCode:
string
Tax code of the product.
-
weight(optional):
string
Weight of the product.
-
width(optional):
string
Width of the product.
Nested Schema : items
Type:
Show Source
object
-
metadata(optional):
object metadata
Seo meta info for product.
-
name(optional):
string
Image filename without path.
-
path(optional):
string
Virtual path to image, including filename.
Nested Schema : metadata
Type:
object
Seo meta info for product.
Show Source
-
altText(optional):
string
Alt text for product image.
-
titleText(optional):
string
Title text for product image.
Nested Schema : directCatalogs
Type:
array
List of catalog IDs that this product is associated with through direct catalog linking.
Show Source
-
Array of:
string
ID of the catalog to which product will have direct linkage.
Nested Schema : filteredCatalogs
Type:
array
List of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
Show Source
-
Array of:
string
List of filtered view catalog ids
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
Show Source
-
priceGroupId1(optional):
object priceGroupId1
List price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
List 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
Show Source
-
priceGroupId1(optional):
object priceGroupId1
Sale price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
Sale price of the product in price group 1
Nested Schema : seoMetaInfo
Type:
object
Seo meta info for category.
Show Source
-
repositoryId(optional):
string
Repository id of seo metadata.
-
seoDescription(optional):
string
Description of product.
-
seoKeywords(optional):
string
Keywords of product.
-
seoTitle(optional):
string
Title of product.
-
seoUrlSlug(optional):
string
Url Slug of product.
Nested Schema : items
Type:
Show Source
object
-
addOnOptions(optional):
array addOnOptions
-
repositoryId(optional):
string
Add-on product group id. If it is provided in the request then it is used to look up the group and make updates to it. If it is not provided in the request then a new group is created that replaces the old one.
Nested Schema : items
Type:
Show Source
object
-
product(optional):
string
ID of the add-on product
-
repositoryId(optional):
string
Add-on option id. If it is provided in the request then it is used to look up the option and make updates to it. If it is not provided in the request then a new add-on option is created that replaces the old one.
-
sku(optional):
string
Sku ID of the add-on product
Nested Schema : priceGroupId1
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
Sale price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
Sale price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateProduct_response
Type:
Show Source
object
-
active(optional):
boolean
Tells whether product is active.
-
addOnProducts(optional):
array addOnProducts
The array of add-on product groups
-
arrivalDate(optional):
string
Arrival date of product.
-
assetable(optional):
boolean
Flag that defines whether a product is assetable or not.
-
brand(optional):
string
Brand of the product.
-
childSKUs(optional):
array childSKUs
Array having the properties of child SKU of the product.
-
coreProduct(optional):
boolean
Flag specifying if this is a core product that should automatically be a member of filtered view catalogs (unless specifically excluded)
-
CountryOfOrigin(optional):
string
Country of origin of the product.
-
creationDate(optional):
string
Creation Date of the product.
-
dateAvailable(optional):
string
Date Available of the product.
-
daysAvailable(optional):
integer
Days Available of the product.
-
defaultProductListingSku(optional):
object defaultProductListingSku
Default Product Listing Sku product
-
derivedListPriceFrom(optional):
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedSalePriceFrom(optional):
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
derivedShippingSurchargeFrom(optional):
string
Determines from which price list group, shipping surcharge is derived. It can be either current price list group or one of it's ancestors
-
description(optional):
string
Description of the product.
-
discountable(optional):
boolean
Indicates whether the promotions should be applied to this SKU or not. If the value is true then promotion discounts can be applied to this SKU; else no promotions can be applied to this SKU. Default value is true
-
displayName(optional):
string
Display Name of the product.
-
dynamicPropertyMapBigString(optional):
string
Dynamic Property MapBigString.
-
dynamicPropertyMapDouble(optional):
string
Dynamic property map double.
-
dynamicPropertyMapLong(optional):
string
Dynamic Property Map Long.
-
dynamicPropertyMapString(optional):
string
Dynamic Property MapString.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
height(optional):
string
Height of the product.
-
id(optional):
string
Product ID.
-
keywords(optional):
array keywords
Keywords of product.
-
largeImage(optional):
object largeImage
Has repository ID and URL of the product.
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs.
-
length(optional):
string
Length of the product.
-
listPrice(optional):
number
List Price of the product in the default price group.
-
listVolumePrice(optional):
object listVolumePrice
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values
-
longDescription(optional):
string
Long description of the product.
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Indicates whether the product is returnable or not.
-
notForIndividualSale(optional):
boolean
States whether not a product may be sold individually rather than, for example, as part of a configured product
-
onlineOnly(optional):
boolean
Tells whether the product is online.
-
orderable(optional):
string
Whether product is orderable.
-
orderLimit(optional):
string
Order limit of the product.
-
parentCategories(optional):
array parentCategories
Array having repository ID of the product.
-
parentCategory(optional):
object parentCategory
Default parent collection of the product.
-
primaryFullImageURL(optional):
string
Primary full image URL of the product.
-
primaryImageAltText(optional):
string
Alt text for product primary image.
-
primaryImageTitle(optional):
string
Title text for product primary image.
-
primaryLargeImageURL(optional):
string
Primary large image URL of the product.
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of the product.
-
primarySourceImageURL(optional):
string
Primary Source Image URL of the product.
-
primaryThumbImageURL(optional):
string
Primary Thumb Image URL of the product.
-
productImages(optional):
array productImages
Array of product images.
-
productImagesMetaData(optional):
array productImagesMetaData
Image Metadata
- relatedProducts(optional): array relatedProducts
-
repositoryId(optional):
string
Repository ID of the product.
-
route(optional):
string
Route of the product.
-
salePrice(optional):
number
Sale Price of the product in the default price group.
-
salePriceEndDate(optional):
string
Sale Price End Date of the product.
-
salePriceStartDate(optional):
string
Sale Price Start Date of the product.
-
saleVolumePrice(optional):
object saleVolumePrice
Sale volume price of the product
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale volume prices as values
-
seoDescriptionDerived(optional):
string
Derived from display name and description of the product
-
seoKeywordsDerived(optional):
string
Derived from display name and ancestor category name's of the product
-
seoMetaInfo(optional):
object seoMetaInfo
Seo meta info for category.
-
seoTitleDerived(optional):
string
Derived from display name of the product
-
seoUrlSlugDerived(optional):
string
Derived from seoUrlSlug of the product if available, else derived from display name of the product
-
shippable(optional):
boolean
Indicates whether the product is goods(shippable=true) or services(shippable=false).
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product in the default price group.
-
smallImageURLs(optional):
array smallImageURLs
Small Image URLs.
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs.
-
taxCode(optional):
string
Tax Code of the product.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of the product.
-
type(optional):
string
Type of product.
-
weight(optional):
string
Weight of the product.
-
width(optional):
string
Width of the product.
Nested Schema : childSKUs
Type:
array
Array having the properties of child SKU of the product.
Show Source
Nested Schema : defaultProductListingSku
Type:
object
Default Product Listing Sku product
Show Source
-
id(optional):
string
Repository ID
Nested Schema : largeImage
Type:
object
Has repository ID and URL of the product.
Show Source
-
id(optional):
string
Repository ID
-
url(optional):
string
Repository URL
Nested Schema : listVolumePrice
Type:
object
list volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
Show Source
-
priceGroupId1(optional):
object priceGroupId1
List price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
List price of the product in price group 1
Nested Schema : parentCategory
Type:
object
Default parent collection of the product.
Show Source
-
repositoryId(optional):
string
Repository id of the default parent collection of the product.
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing 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
Show Source
-
priceGroupId1(optional):
object priceGroupId1
Sale price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
Sale price of the product in price group 1
Nested Schema : seoMetaInfo
Type:
object
Seo meta info for category.
Show Source
-
repositoryId(optional):
string
Repository id of seo metadata.
-
seoDescription(optional):
string
Description of product.
-
seoKeywords(optional):
string
Keywords of product.
-
seoTitle(optional):
string
Title of product.
-
seoUrlSlug(optional):
string
Url Slug of product.
Nested Schema : items
Type:
Show Source
object
-
product(optional):
object product
The add-on product
-
repositoryId(optional):
string
-
sku(optional):
object sku
The add-on sku
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether sku is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
-
bundleLinks(optional):
array bundleLinks
Array of bundle links associated with the SKU
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedListPriceFrom(optional):
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedSalePriceFrom(optional):
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
dynamicPropertyMapLong(optional):
string
Dynamic Property MapLong of SKU.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
largeImage(optional):
string
Large Image of the SKU.
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
List Price of the product SKU.
-
listVolumePrice(optional):
object listVolumePrice
list volume price of the sku
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Indicates whether the SKU is returnable or not.
-
primaryLargeImageURL(optional):
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of SKU.
-
primarySourceImageURL(optional):
string
Primary Source Image URL of SKU.
-
primaryThumbImageURL(optional):
string
Primary Source Image URL of SKU.
-
quantity(optional):
integer
Quantity available of SKU.
-
repositoryId(optional):
string
Repository ID of SKU.
-
salePrice(optional):
string
Sale Price of SKU.
-
salePriceEndDate(optional):
string
Sale Price End Date of the SKU.
-
salePriceStartDate(optional):
string
Sale Price Start Date of SKU.
-
saleVolumePrice(optional):
object saleVolumePrice
Sale volume price of the sku
-
shippingSurcharge(optional):
number
Extra handling cost while shipping the product.
-
smallImage(optional):
string
Small Image URL of SKU.
-
smallImageURLs(optional):
array smallImageURLs
Small Image URLs of SKU.
-
soldAsPackage(optional):
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage(optional):
string
Thumbnail Image of SKU.
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrice
Type:
object
list volume price of the sku
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the sku
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The id of the bundle link
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the configuration attribute.
-
repositoryId(optional):
string
The repository id for existing configuration metadata items.
-
value(optional):
string
The value of the configuration attribute.
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository ID of product.
Nested Schema : items
Type:
Show Source
object
-
metadata(optional):
object metadata
Seo meta info for product.
-
name(optional):
string
The name of product image
-
path(optional):
string
The path of the image
-
repositoryId(optional):
string
The repository Id of the product image
-
tags(optional):
array tags
The array of product image tags
-
url(optional):
string
The url of the product image
Nested Schema : metadata
Type:
object
Seo meta info for product.
Show Source
-
altText(optional):
string
The alt text of the image
-
titleText(optional):
string
The title text of the image
Nested Schema : items
Type:
Show Source
object
-
altText(optional):
string
Alt text for product image.
-
titleText(optional):
string
Title text for product image.
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
Sale price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
Sale price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Example Response (application/json)
{
"dynamicPropertyMapLong":{
},
"largeImage":{
"repositoryId":"m2502",
"url":"/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
},
"keywords":[
"offers",
"batteries",
"traditional",
"requires",
"army",
"fm",
"life",
"battery",
"radio",
"included",
"styling",
"vintage-style",
"inspired",
"sounds"
],
"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,
"nonreturnable":false,
"displayName":"A-Line Skirt",
"description":"The simple perfect A line",
"primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg",
"type":"1102",
"largeImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=940&width=940"
],
"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"
],
"derivedShippingSurchargeFrom":"UsDollar",
"derivedSalePriceFrom":"UsDollar",
"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",
"nonreturnable":false,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"thumbnailImage":null,
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"size":"Small",
"mediumImageURLs":[
],
"repositoryId":"xsku2535_1",
"derivedListPriceFrom":"UsDollar",
"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",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300"
],
"listPrice":55
}
],
"orderLimit":null,
"onlineOnly":false,
"listPrices":{
"UsDollar":69,
"CaDollar":79
},
"type":null,
"seoMetaInfo":{
"seoDescription":"Army Radio,FM / AM battery radio with traditional styling",
"repositoryId":"100002",
"seoTitle":"Army Radio",
"seoKeywords":"Army Radio,Radios,For Her",
"seoUrlSlug":"army-radio"
},
"largeImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=940&width=940"
],
"listVolumePrices":{
},
"shippable":true,
"addOnProducts":[
{
"repositoryId":"cp10001",
"addOnOptions":[
{
"product":{
"displayName":"Gift Wrapping",
"repositoryId":"prod10005",
"active":true
},
"repositoryId":"co10002",
"sku":{
"displayName":"Shiny Wrapping Paper",
"repositoryId":"sku10006",
"active":true
}
},
{
"product":{
"displayName":"Gift Wrapping",
"repositoryId":"prod10005",
"active":true
},
"repositoryId":"co10003",
"sku":{
"displayName":"Birthday Wrapping Paper",
"repositoryId":"sku10007",
"active":true
}
}
]
}
],
"derivedSalePriceFrom":"UsDollar",
"primaryImageAltText":"Army Radio",
"id":"xprod2046",
"brand":"Style by\n\t\t\tZhanna",
"parentCategories":[
{
"repositoryId":"cat10020"
}
],
"salePriceEndDate":null,
"height":null,
"defaultProductListingSku":null,
"assetable":false,
"primaryMediumImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=475&width=475",
"seoKeywordsDerived":"Army Radio,Radios,For Her",
"seoUrlSlugDerived":"army-radio",
"dynamicPropertyMapBigString":{
},
"active":true,
"weight":null,
"thumbImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=100&width=100"
],
"creationDate":"2007-12-04T07:49:42.000Z",
"taxCode":"PC030100",
"arrivalDate":null,
"route":"/army-radio/product/xprod2046",
"mediumImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=475&width=475"
],
"parentCategory":{
"repositoryId":"cat10020"
},
"primarySourceImageURL":"http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg",
"primarySmallImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=300&width=300",
"sourceImageURLs":[
"http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
],
"longDescription":"Inspired by life in the army, this\n\t\t\tvintage-style radio offers modern-day sounds. Requires 2 D-cell\n\t\t\tbatteries, not included.",
"primaryThumbImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=100&width=100",
"nonreturnable":false,
"displayName":"Army Radio",
"seoDescriptionDerived":"Army Radio,FM / AM battery radio with traditional styling",
"description":"FM / AM battery radio with traditional\n\t\t\tstyling",
"primaryFullImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg",
"salePrices":{
"UsDollar":null,
"CaDollar":null
},
"seoTitleDerived":"Army Radio",
"primaryLargeImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=940&width=940",
"smallImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"UsDollar",
"shippingSurcharges":{
"UsDollar":20,
"CaDollar":30
},
"dynamicPropertyMapString":{
},
"discountable":true,
"saleVolumePrices":{
},
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
{
"repositoryId":"skul40005"
}
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"thumbnailImage":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":96,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"xsku2046",
"derivedListPriceFrom":"UsDollar",
"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,
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":20,
"daysAvailable":2302,
"dynamicPropertyMapDouble":{
},
"listPrice":69
}
412 Response
ETag mismatch. Asset has been updated by another user.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle CX Commerce:
|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|
|200226|Operation on product is not allowed for the custom catalog|
|26510|Attempt to set an add-on link {0} that does not belong to product {1}|
|26511|Attempt to set an add-on option {0} that does not belong to add-on link {1}|200240|parentCategoryScope is not revertToBase but parentCategory is not in the request|
|200241|parentCategory is not a parent of the collection|
|200242|catalogSpecific or revertToBase parentCategoryScope but no catalog specified in the request|
|200243|parentCategoryScope invalid/unknown value|
|200244|catalogSpecific parentCategoryScope but parentCategory is not in the specified catalog|
|20026|One or more filtered catalogs are not linked to the catalog in context.|
|20027|Product (0) is not in a V2 catalog associated with all filtered catalogs|
|20182|Invalid value type for property
|20044|One or more direct catalogs does not exists.|
|20045|Direct catalogs must be a valid version 2 catalog.|
|20046|Internal error occurred while fetching direct catalogs for product.|
|20047|Direct catalogs passed must be an instance of list.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code