createSkus
put
/ccadmin/v1/skus
Create Skus. Create skus for product 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
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Root Schema : createSkus_request
Type:
Show Source
object
-
includePrices(optional):
boolean
Boolean flag to determine whether to include price maps for the skus in the response.
-
priceListGroupId(optional):
string
Price List Group ID for listing the prices to the SKU in the response. Does not affect the price set in the input.
-
productId:
string
ID of the product for which the SKUs will be created.
-
variants:
array variants
Array of SKUs to be created. Individual SKU IDs must be specified. Variant properties must be included, as appropriate. listPrice can be included optionally.
Example:
{
"productId":"xprod12345",
"variants":[
{
"color":"red",
"id":"sku1",
"listPrice":"200"
},
{
"color":"blue",
"id":"sku2"
}
]
}
Nested Schema : variants
Type:
array
Array of SKUs to be created. Individual SKU IDs must be specified. Variant properties must be included, as appropriate. listPrice can be included optionally.
Show Source
Nested Schema : items
Type:
Show Source
object
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
id:
string
The ID for the SKU to be created. Required.
-
listPrice(optional):
List price for the default Price List Group. Optional.
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the configuration attribute.
-
value(optional):
string
The value of the configuration attribute.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createSkus_response
Type:
Show Source
object
-
items(optional):
array items
the list of created skus
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.
-
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 Source 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,
"largeImage":null,
"smallImage":null,
"color":"red",
"nonreturnable":false,
"listPrices":{
"UsDollar":"200"
},
"salePrices":null,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":null,
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku1",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":"200",
"configurable":"false"
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
"sku-MensApparel_color":3
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"color":"Blue",
"nonreturnable":false,
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"saleVolumePrices":null,
"barcode":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku2",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null,
"configurable":"false"
}
]
Default Response
The error response
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