updateSku
put
/ccadmin/v1/skus/{id}
Update Sku. Updates a SKU based on the input request parameters. **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
SKU ID corresponding to the SKU to be updated.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : updateSku_request
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.
-
barcode(optional):
string
Barcode property of the sku
-
bundleLinks(optional):
array bundleLinks
Array of bundle links to be associated with the SKU
-
configurable(optional):
boolean
Indicates whether the SKU is configurable or not
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
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 SKU.
-
images(optional):
array images
Array of images to be associated to the SKU.
-
includePrices(optional):
boolean
Boolean flag to determine whether to include price maps for the skus in the response.
-
listPrice(optional):
string
List Price of SKU.
-
listVolumePrices(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values
-
model(optional):
string
Model property of the SKU
-
nonreturnable(optional):
boolean
Indicates whether the SKU is returnable or not.
-
priceListGroupId(optional):
string
Price list group id for adding the prices to the SKU in the response.
-
productFamily(optional):
string
Product Family property of the SKU
-
productLine(optional):
string
Product line property of the SKU
-
productListingSku(optional):
boolean
This is true if this sku is the listing sku for a particular variant.
-
quantity(optional):
integer
Quantity of the SKU.
-
salePrice(optional):
string
Sale Price of SKU.
-
salePriceEndDate(optional):
string
Sale Price End Date of SKU.
-
salePriceStartDate(optional):
string
Sale Price start date of the SKU.
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale prices as values
-
soldAsPackage(optional):
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
unitOfMeasure(optional):
string
Unit Of Measure property of the SKU.
Example:
{
"productFamily":null,
"bundleLinks":[
{
"item":{
"repositoryId":"sku30001"
},
"quantity":1
},
{
"item":{
"repositoryId":"sku30002"
},
"quantity":2
}
],
"salePrice":"300",
"nonreturnable":false,
"displayName":"SKU One",
"active":false,
"listPrices":{
"UsDollar":"500"
},
"salePrices":{
"UsDollar":"300"
},
"configurationMetadata":[
{
"name":"bundleSelected",
"repositoryId":"cmi10001",
"value":"Better Double"
}
],
"productLine":null,
"listVolumePrices":{
"CaDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"soldAsPackage":false,
"model":null,
"discountable":true,
"saleVolumePrices":{
"CaDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"barcode":null,
"listPrice":"500",
"configurable":"false"
}
Nested Schema : bundleLinks
Type:
array
Array of bundle links to be associated with the SKU
Show Source
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
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 2
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 2
Nested Schema : items
Type:
Show Source
object
-
item(optional):
object item
The SKU that will be included into this bundle link
-
quantity(optional):
integer
The quantity of the item
Nested Schema : item
Type:
object
The SKU that will be included into this bundle link
Show Source
-
repositoryId(optional):
string
The id of the SKU included in 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 : items
Type:
Show Source
object
-
metadata(optional):
object metadata
Seo meta info.
-
name(optional):
string
The name of image.
-
path(optional):
string
The relative path to the image.
-
repositoryId:
string
The repository Id of the image.
-
url(optional):
string
The complete url of the image.
Nested Schema : metadata
Type:
object
Seo meta info.
Show Source
-
altText(optional):
string
Alt text for the image.
-
titleText(optional):
string
Title text for the image.
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 2
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 2
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 : updateSku_response
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.
-
barcode(optional):
string
Barcode property of the sku.
-
bundleLinks(optional):
array bundleLinks
Array of bundle links associated with the SKU.
-
configurable(optional):
boolean
Indicates whether the SKU is configurable or not.
-
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
-
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 SKU.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
images(optional):
array images
Array of images for the SKU.
-
largeImage(optional):
integer
Large image of the SKU.
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
List price of the SKU.
-
listVolumePrice(optional):
object listVolumePrice
List volume price of the SKU.
-
listVolumePrices(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values.
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
model(optional):
string
Model property of the SKU.
-
nonreturnable(optional):
boolean
Determines SKU product is returnable or not
-
primaryFullImageURL(optional):
string
Primary full image URL.
-
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 Thumb Image URL of SKU.
-
productFamily(optional):
string
Product Family property of the SKU.
-
productLine(optional):
string
Product line property of the SKU.
-
productListingSku(optional):
boolean
This is true if this sku is the listing sku for a particular variant.
-
quantity(optional):
integer
Quantity of the SKU.
-
repositoryId(optional):
string
Repository ID of the SKU.
-
salePrice(optional):
string
Sale price of the SKU.
-
salePriceEndDate(optional):
integer
Sale price end date of the SKU.
-
salePriceStartDate(optional):
string
Sale price start date of the SKU.
-
saleVolumePrice(optional):
object saleVolumePrice
Sale volume price of the SKU.
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale prices as values.
-
smallImage(optional):
integer
Small image of the 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 the SKU.
-
unitOfMeasure(optional):
string
Unit Of Measure property of the 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 : 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 SKU in price group 1
-
PriceGroupID2(optional):
object PriceGroupID2
List price of the SKU in price group 2
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 : 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 Sku in price group 1
-
PriceGroupID2(optional):
object PriceGroupID2
Sale price of the SKU in price group 2
Nested Schema : items
Type:
Show Source
object
-
item(optional):
object item
The SKU that will be included into this bundle link
-
quantity(optional):
integer
The quantity of the item
-
repositoryId(optional):
string
The id of the bundle link
Nested Schema : item
Type:
object
The SKU that will be included into this bundle link
Show Source
-
displayName(optional):
string
The name of the SKU included in the bundle link
-
repositoryId(optional):
string
The id of the SKU included in 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 : items
Type:
Show Source
object
-
metadata(optional):
object metadata
Seo meta info.
-
name(optional):
string
Name of the image to be updated.
-
path(optional):
string
Path of the image to be updated.
-
repositoryId(optional):
string
Repository ID of the image.
-
tags(optional):
array tags
Tags for the image.
-
url(optional):
string
The complete url of the image.
Nested Schema : metadata
Type:
object
Seo meta info.
Show Source
-
altText(optional):
string
Alt text for image.
-
titleText(optional):
string
Title text for 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
List price of the SKU 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 SKU in price group 2
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 : 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 Sku 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 SKU in price group 2
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)
{
"productFamily":null,
"dynamicPropertyMapLong":{
"sku-MensApparel_color":2
},
"primaryThumbImageURL":null,
"bundleLinks":[
{
"item":{
"displayName":"Blue T Shirt",
"repositoryId":"sku30001"
},
"quantity":1,
"repositoryId":"skul10001"
},
{
"item":{
"displayName":"Red T Shirt",
"repositoryId":"sku30002"
},
"quantity":1,
"repositoryId":"skul10002"
}
],
"largeImage":null,
"smallImage":null,
"color":"Blue",
"listVolumePrice":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
},
"nonreturnable":false,
"displayName":"sku One",
"salePrices":{
"UsDollar":"300"
},
"primaryFullImageURL":null,
"listPrices":{
"UsDollar":"500"
},
"configurationMetadata":[
{
"name":"bundleSelected",
"repositoryId":"cmi10001",
"value":"Better Double"
}
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"CaDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":null,
"saleVolumePrices":{
"CaDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"salePriceEndDate":null,
"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,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":"300",
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":false,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku1",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":"500",
"configurable":"false"
}
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|
|------------------|------------------|
|26041|attempt to set or query property {0} with invalid enumeration value {1}.|
|26051|Active property value can only be a Boolean.|
|26300|The SKU {0} is already part of a SKU bundle|
|26048|Missing variant property for item: {0}, {1}|
|26301|Item is required for BundleLinks.|
|26304|The SKU {0} is already a SKU bundle.|
|26303|{0} is an invalid SKU ID.|
|26306|Internal Error|
|26305|The ID for the SKU bundle cannot be the same as the ID for one of its bundle links.|
|26307|Invalid Quantity Value.|
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