createSku
post
/ccadmin/v1/skus
Create Sku. Create a SKU for product based on the input request parameters. The request contains dynamic properties associated with product type. **Requires the x-ccasset-language header so translated content can be set for a specific language.**
Request
Supported Media Types
- application/json
Header Parameters
-
X-CC-Workset: string
The ID of the workset that this change will appear in. If this header is missing, the change will be made in the default workset.
-
X-CCAsset-Language(required): string
The asset language of the request
Root Schema : createSku_request
Type:
Show Source
object-
active:
boolean
Indicates whether SKU is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
-
barcode:
string
Barcode property of the SKU.
-
configurable:
boolean
Indicates whether the SKU is configurable or not.
-
configurationMetadata:
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
discountable:
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:
string
Display name of the SKU.
-
id(required):
string
Variant ID.
-
images:
array images
Array of images to be associated to the SKU.
-
includePrices:
boolean
Boolean flag to determine whether to include price maps for the skus in the response.
-
listPrice:
number
List price of the SKU in the default price group. Required if listPrices does not set the price for the default price group.
-
listVolumePrices:
object listVolumePrices
Object with price group IDs as keys and List prices as volumes.
-
model:
string
Model property of the SKU.
-
nonreturnable:
boolean
Indicates whether the SKU is returnable or not.
-
priceListGroupId:
string
Price list group id for adding the prices to the SKU in the response.
-
productFamily:
string
Product Family property of the SKU.
-
productId(required):
string
ID corresponding to the product.
-
productLine:
string
Product line property of the SKU.
-
productListingSku:
boolean
This is true if this sku is the listing sku for a particular variant.
-
quantity:
integer
Quantity of the SKU.
-
salePrice:
number
Sale price of the SKU in the default price group.
-
salePriceEndDate:
string
Sale Price End Date of SKU.
-
salePriceStartDate:
string
Sale Price start date of the SKU.
-
saleVolumePrices:
object saleVolumePrices
Object with price group IDs as keys and Sale Prices as values.
-
shippingSurcharge:
number
Extra handling costs while shipping the product, in the default price group.
-
shippingSurcharges:
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
soldAsPackage:
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
unitOfMeasure:
string
Unit Of Measure property of the SKU.
Example:
{
"productFamily":null,
"color":"Brown",
"nonreturnable":false,
"displayName":"SKU One",
"listPrices":{
"defaultPriceGroup":"20"
},
"salePrices":{
"defaultPriceGroup":"10"
},
"configurationMetadata":[
],
"productLine":null,
"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":{
"defaultPriceGroup":"20"
},
"model":null,
"id":"sku1",
"discountable":true,
"barcode":null,
"saleVolumePrices":{
"UsDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"salePriceEndDate":"2018-03-11T18:30:00.000Z",
"salePriceStartDate":"2017-11-11T18:30:00.000Z",
"quantity":15,
"productId":"xsku100234",
"unitOfMeasure":null,
"salePrice":"10",
"active":true,
"soldAsPackage":false,
"size":"Small",
"shippingSurcharge":"20",
"configurable":"false",
"listPrice":"20"
}Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrices
Type:
objectObject with price group IDs as keys and List prices as volumes.
Show Source
-
PriceGroupID1:
object PriceGroupID1
List price of the product in price group 1
-
PriceGroupID2:
object PriceGroupID2
List price of the product in price group 2
Nested Schema : saleVolumePrices
Type:
objectObject with price group IDs as keys and Sale Prices as values.
Show Source
-
PriceGroupID1:
object PriceGroupID1
Sale price of the product in price group 1
-
PriceGroupID2:
object PriceGroupID2
Sale price of the product in price group 2
Nested Schema : shippingSurcharges
Type:
objectExtra handling costs for shipping the product in respective price list groups
Show Source
-
plg1:
number
Extra handling costs for shipping the product in plg1
-
plg2:
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object-
name:
string
The name of the configuration attribute.
-
value:
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object-
metadata:
object metadata
Seo meta info.
-
name:
string
The name of image.
-
path:
string
The relative path to the image.
-
repositoryId(required):
string
The repository Id of the image.
-
url:
string
The complete url of the image.
Nested Schema : metadata
Type:
objectSeo meta info.
Show Source
-
altText:
string
Alt text for the image.
-
titleText:
string
Title text for the image.
Nested Schema : PriceGroupID1
Type:
objectList price of the product in price group 1
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectList price of the product in price group 2
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : PriceGroupID1
Type:
objectSale price of the product in price group 1
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectSale price of the product in price group 2
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createSku_response
Type:
Show Source
object-
active:
boolean
Indicates whether SKU is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
-
barcode:
string
Barcode property of the sku.
-
bundleLinks:
array bundleLinks
Array of bundle links associated with the SKU.
-
configurable:
boolean
Indicates whether the SKU is configurable or not.
-
configurationMetadata:
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedListPriceFrom:
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:
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:
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
-
discountable:
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:
string
Display name of the SKU.
-
fullImageURLs:
array fullImageURLs
Full Image URLs of SKU.
-
images:
array images
Array of images for the SKU.
-
largeImage:
integer
Large image of the SKU.
-
largeImageURLs:
array largeImageURLs
Large Image URLs of SKU.
-
listPrice:
number
List price of the SKU.
-
listVolumePrice:
object listVolumePrice
List volume price of the SKU.
-
listVolumePrices:
object listVolumePrices
Object with price group IDs as keys and list prices as values.
-
mediumImageURLs:
array mediumImageURLs
Medium Image URLs SKU.
-
model:
string
Model property of the SKU.
-
nonreturnable:
boolean
Determines SKU product is returnable or not
-
primaryFullImageURL:
string
Primary full image URL.
-
primaryLargeImageURL:
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL:
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL:
string
Primary Small Image URL of SKU.
-
primarySourceImageURL:
string
Primary Source Image URL of SKU.
-
primaryThumbImageURL:
string
Primary Thumb Image URL of SKU.
-
productFamily:
string
Product Family property of the SKU.
-
productLine:
string
Product line property of the SKU.
-
productListingSku:
boolean
This is true if this sku is the listing sku for a particular variant.
-
quantity:
integer
Quantity of the SKU.
-
repositoryId:
string
Repository ID of the SKU.
-
salePrice:
string
Sale price of the SKU.
-
salePriceEndDate:
integer
Sale price end date of the SKU.
-
salePriceStartDate:
string
Sale price start date of the SKU.
-
saleVolumePrice:
object saleVolumePrice
Sale volume price of the SKU.
-
saleVolumePrices:
object saleVolumePrices
Object with price group IDs as keys and sale prices as values.
-
shippingSurcharge:
number
Extra handling costs while shipping the product, in the default price group.
-
shippingSurcharges:
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage:
integer
Small image of the SKU.
-
smallImageURLs:
array smallImageURLs
Small Image URLs of SKU.
-
soldAsPackage:
boolean
Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
-
sourceImageURLs:
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs:
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage:
string
Thumbnail image of the SKU.
-
unitOfMeasure:
string
Unit Of Measure property of the SKU.
Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrice
Type:
objectList volume price of the SKU.
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
objectObject with price group IDs as keys and list prices as values.
Show Source
-
PriceGroupID1:
object PriceGroupID1
List price of the SKU in price group 1
-
PriceGroupID2:
object PriceGroupID2
List price of the SKU in price group 2
Nested Schema : saleVolumePrice
Type:
objectSale volume price of the SKU.
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
objectObject with price group IDs as keys and sale prices as values.
Show Source
-
PriceGroupID1:
object PriceGroupID1
Sale price of the Sku in price group 1
-
PriceGroupID2:
object PriceGroupID2
Sale price of the SKU in price group 2
Nested Schema : shippingSurcharges
Type:
objectExtra handling costs for shipping the product in respective price list groups
Show Source
-
plg1:
number
Extra handling costs for shipping the product in plg1
-
plg2:
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object-
item:
object item
The SKU that will be included into this bundle link
-
quantity:
integer
The quantity of the item
-
repositoryId:
string
The id of the bundle link
Nested Schema : item
Type:
objectThe SKU that will be included into this bundle link
Show Source
-
displayName:
string
The name of the SKU included in the bundle link
-
repositoryId:
string
The id of the SKU included in the bundle link
Nested Schema : items
Type:
Show Source
object-
name:
string
The name of the configuration attribute.
-
repositoryId:
string
The repository id.
-
value:
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object-
metadata:
object metadata
Seo meta info.
-
name:
string
Name of the image to be updated.
-
path:
string
Path of the image to be updated.
-
repositoryId:
string
Repository ID of the image.
-
tags:
array tags
Tags for the image.
-
url:
string
The complete url of the image.
Nested Schema : metadata
Type:
objectSeo meta info.
Show Source
-
altText:
string
Alt text for image.
-
titleText:
string
Title text for image.
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : PriceGroupID1
Type:
objectList price of the SKU in price group 1
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectList price of the SKU in price group 2
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : PriceGroupID1
Type:
objectSale price of the Sku in price group 1
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectSale price of the SKU in price group 2
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels:
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum:
number
minimum quantity for price level
-
price:
number
price value for price level
Example Response (application/json)
{
"dynamicPropertyMapLong":{
"sku-MensApparel_color":2
},
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":{
"defaultPriceGroup":null
},
"configurationMetadata":[
{
"name":"bundleSelected",
"repositoryId":"cmi10001",
"value":"Better Double"
}
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"UsDollar",
"model":null,
"barcode":null,
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"color":"Blue",
"nonreturnable":false,
"displayName":"Sku One",
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"productListingSku":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedShippingSurchargeFrom":"UsDollar",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"discountable":true,
"saleVolumePrices":{
"defaultPriceGroup":null
},
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":null,
"salePrice":null,
"fullImageURLs":[
],
"soldAsPackage":false,
"repositoryId":"sku1",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"listPrice":30,
"configurable":false
}Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code