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-CCAsset-Language
-
Type:
stringRequired:trueThe asset language of the request
Body Parameter
Root Schema : createSku_request
{
"productFamily":null,
"productId":"xsku100234",
"color":"Brown",
"salePrice":"10",
"active":true,
"salePrices":{
"defaultPriceGroup":"10"
},
"listPrices":{
"defaultPriceGroup":"20"
},
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"size":"Small",
"model":null,
"id":"sku1",
"barcode":null,
"listPrice":"20",
"configurable":"false"
}
- active
-
Type:
booleanIndicates whether SKU is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true. - id
-
Type:
stringRequired:trueVariant ID - images
-
Type:
arrayimagesArray of images to be associated to the SKU. - includePrices
-
Type:
booleanBoolean flag to determine whether to include price maps for the skus in the response. - listPrice
-
Type:
stringList Price of SKU. - listVolumePrices
-
Type:
objectlistVolumePricesObject with price group IDs as keys and list prices as values - priceListGroupId
-
Type:
stringPrice list group id for adding the prices to the SKU in the response. - productId
-
Type:
stringRequired:trueID corresponding to the product. - salePrice
-
Type:
stringSale Price of SKU. - saleVolumePrices
-
Type:
objectsaleVolumePricesObject with price group IDs as keys and sale prices as values
Nested Schema : images
Nested Schema : listVolumePrices
Type:
objectObject with price group IDs as keys and list prices as values
- PriceGroupID1
-
Type:
objectPriceGroupID1List price of the product in price group 1 - PriceGroupID2
-
Type:
objectPriceGroupID2List price of the product in price group 2
Nested Schema : saleVolumePrices
Type:
objectObject with price group IDs as keys and sale prices as values
- PriceGroupID1
-
Type:
objectPriceGroupID1Sale price of the product in price group 1 - PriceGroupID2
-
Type:
objectPriceGroupID2Sale price of the product in price group 2
Nested Schema : items
Type:
object- metadata
-
Type:
objectmetadataSeo meta info. - name
-
Type:
stringThe name of image. - path
-
Type:
stringThe relative path to the image. - repositoryId
-
Type:
stringRequired:trueThe repository Id of the image. - url
-
Type:
stringThe complete url of the image.
Nested Schema : metadata
Type:
objectSeo meta info.
- altText
-
Type:
stringAlt text for the image. - titleText
-
Type:
stringTitle text for the image.
Nested Schema : PriceGroupID1
Type:
objectList price of the product in price group 1
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectList price of the product in price group 2
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : PriceGroupID1
Type:
objectSale price of the product in price group 1
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectSale price of the product in price group 2
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createSku_response
- active
-
Type:
booleanIndicates whether SKU is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true. - barcode
-
Type:
stringBarcode property of the sku - configurable
-
Type:
booleanIndicates whether the SKU is configurable or not - fullImageURLs
-
Type:
arrayfullImageURLsFull Image URLs of SKU. - largeImage
-
Type:
integerLarge image of the SKU. - largeImageURLs
-
Type:
arraylargeImageURLsLarge Image URLs of SKU. - listPrice
-
Type:
numberList price of the SKU. - listVolumePrice
-
Type:
objectlistVolumePricelist volume price of the SKU - listVolumePrices
-
Type:
objectlistVolumePricesObject with price group IDs as keys and list prices as values - mediumImageURLs
-
Type:
arraymediumImageURLsMedium Image URLs SKU. - model
-
Type:
stringModel property of the SKU - primaryLargeImageURL
-
Type:
stringPrimary Large Image URL of SKU. - primaryMediumImageURL
-
Type:
stringPrimary Medium Image URL ID of SKU. - primarySmallImageURL
-
Type:
stringPrimary Small Image URL of SKU. - primarySourceImageURL
-
Type:
stringPrimary Source Image URL of SKU. - primaryThumbImageURL
-
Type:
stringPrimary Source Image URL of SKU. - productFamily
-
Type:
stringProduct Family property of the SKU - productLine
-
Type:
stringProduct line property of the SKU - productListingSku
-
Type:
booleanThis is true if this sku is the listing sku for a particular variant - quantity
-
Type:
integerQuantity of the SKU. - repositoryId
-
Type:
stringRepository ID of the SKU. - salePrice
-
Type:
stringSale price of the SKU. - salePriceEndDate
-
Type:
integerSale price end date of the SKU. - salePriceStartDate
-
Type:
stringSale price start date of the SKU. - saleVolumePrice
-
Type:
objectsaleVolumePriceSale volume price of the SKU - saleVolumePrices
-
Type:
objectsaleVolumePricesObject with price group IDs as keys and sale prices as values - smallImage
-
Type:
integerSmall image of the SKU. - smallImageURLs
-
Type:
arraysmallImageURLsSmall Image URLs of SKU. - sourceImageURLs
-
Type:
arraysourceImageURLsSource Image URLs of SKU. - thumbImageURLs
-
Type:
arraythumbImageURLsThumb Image URLs of SKU. - thumbnailImage
-
Type:
stringThumbnail image of the SKU.
Nested Schema : fullImageURLs
Nested Schema : largeImageURLs
Nested Schema : listVolumePrice
Type:
objectlist volume price of the SKU
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
objectObject with price group IDs as keys and list prices as values
- PriceGroupID1
-
Type:
objectPriceGroupID1List price of the SKU in price group 1 - PriceGroupID2
-
Type:
objectPriceGroupID2List price of the SKU in price group 2
Nested Schema : mediumImageURLs
Nested Schema : saleVolumePrice
Type:
objectSale volume price of the SKU
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
objectObject with price group IDs as keys and sale prices as values
- PriceGroupID1
-
Type:
objectPriceGroupID1Sale price of the Sku in price group 1 - PriceGroupID2
-
Type:
objectPriceGroupID2Sale price of the SKU in price group 2
Nested Schema : smallImageURLs
Nested Schema : sourceImageURLs
Nested Schema : thumbImageURLs
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : PriceGroupID1
Type:
objectList price of the SKU in price group 1
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectList price of the SKU in price group 2
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : PriceGroupID1
Type:
objectSale price of the Sku in price group 1
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : PriceGroupID2
Type:
objectSale price of the SKU in price group 2
- pricingScheme
-
Type:
objectpricingSchemePricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
- levels
-
Type:
arraylevelsPrice levels array for volume price - numLevels
-
Type:
numberNumber of levels in the volume price
Nested Schema : items
Type:
object- levelMaximum
-
Type:
numberminimum quantity for price level - levelMinimum
-
Type:
numberminimum quantity for price level - price
-
Type:
numberprice value for price level
Example application/json
{
"productFamily":null,
"dynamicPropertyMapLong":{
"sku-MensApparel_color":2
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"color":"Blue",
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"model":null,
"thumbnailImage":null,
"saleVolumePrices":null,
"barcode":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"sku1",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null,
"configurable":"false"
}
Default Response
The error response
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAn optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Request:
{
"productFamily": null,
"productId": "xsku100234",
"color": "Brown",
"salePrice": "10",
"active": true,
"salePrices": {"defaultPriceGroup": "10"},
"listPrices": {"defaultPriceGroup": "20"},
"productLine": null,
"listVolumePrices": {"defaultPriceGroup": null},
"size": "Small",
"model": null,
"id": "sku1",
"barcode": null,
"listPrice": "20",
"configurable": "false"
}
Sample Response Payload returned by endpoint:
{
"productFamily": null,
"dynamicPropertyMapLong": {"sku-MensApparel_color": 2},
"primaryThumbImageURL": null,
"largeImage": null,
"smallImage": null,
"listVolumePrice": null,
"color": "Blue",
"listPrices": null,
"salePrices": null,
"primaryFullImageURL": null,
"productListingSku": null,
"largeImageURLs": [],
"productLine": null,
"listVolumePrices": null,
"primaryLargeImageURL": null,
"smallImageURLs": [],
"model": null,
"thumbnailImage": null,
"saleVolumePrices": null,
"barcode": null,
"salePriceEndDate": null,
"saleVolumePrice": null,
"salePriceStartDate": null,
"images": [],
"quantity": null,
"salePrice": null,
"primaryMediumImageURL": null,
"fullImageURLs": [],
"thumbImageURLs": [],
"mediumImageURLs": [],
"repositoryId": "sku1",
"primarySourceImageURL": null,
"primarySmallImageURL": null,
"sourceImageURLs": [],
"listPrice": null,
"configurable": "false"
}