getSku
get
/ccadmin/v1/skus/{id}
Get Sku. Gets a SKU and its properties. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The skuId.
Query Parameters
-
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 adding the prices to the SKU in the response.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSku_response
Type:
Show Source
object
-
barcode(optional):
number
The barcode
-
configurable(optional):
boolean
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
-
derivedOnlineOnly(optional):
boolean
Indicates if the SKU is available online or not.
-
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
-
displayName(optional):
string
The display name of the SKU
-
fractionalQuantitiesAllowed(optional):
boolean
Whether fractional quantities are allowed
-
fullImageURLs(optional):
array fullImageURLs
The array of full image URLs
-
images(optional):
array images
Image URLs of SKU.
-
largeImage(optional):
string
large image path of the SKU
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listPrice(optional):
number
The list price
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
listVolumePrice(optional):
number
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
list volume prices of the product in respective price list groups
-
mediumImageURLs(optional):
array mediumImageURLs
medium image urls path
-
model(optional):
string
The model property of SKU.
-
nonreturnable(optional):
string
Indicates whether the SKU is returnable or not.
-
parentProducts(optional):
array parentProducts
The list of parent products for the SKU.
-
primaryFullImageURL(optional):
string
Primary Full Image URL of SKU.
-
primaryLargeImageURL(optional):
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL(optional):
string
primary medium image url path
-
primarySmallImageURL(optional):
string
Primary Small Image URL of SKU.
-
primarySourceImageURL(optional):
string
primary source image url path
-
primaryThumbImageURL(optional):
string
Primary Source Image URL of SKU.
-
productFamily(optional):
string
product family property of the SKU
-
productLine(optional):
string
product line of the SKU
-
productListingSku(optional):
object productListingSku
product listing SKU property of the SKU
-
productVariantOptions(optional):
array productVariantOptions
The selected options for the SKU.
-
quantity(optional):
integer
quantity of the SKU
-
repositoryId(optional):
string
repository id of the child SKU
-
salePrice(optional):
number
sale price of the SKU.
-
salePriceEndDate(optional):
string
sale price end date of the SKU
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
salePriceStartDate(optional):
string
sale price start date of the SKU
-
saleVolumePrice(optional):
number
The sale volume price
-
saleVolumePrices(optional):
object saleVolumePrices
Sale volume prices of the product in respective price list groups
-
smallImage(optional):
array smallImage
The array of small image URLs
-
smallImageURLs(optional):
array smallImageURLs
small image url paths
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU
-
thumbnailImage(optional):
string
The thumbanil image of the SKU
-
unitOfMeasure(optional):
string
unit of measure of the SKU
-
variantValuesOrder(optional):
object variantValuesOrder
Object having various variant property as key and ordered values array as the value.
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : listPrices
Type:
object
list prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : listVolumePrices
Type:
object
list volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list volume price of the product in plg1
-
plg2(optional):
number
list volume price of the product in plg2
Nested Schema : productListingSku
Type:
object
product listing SKU property of the SKU
Nested Schema : salePrices
Type:
object
sale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : saleVolumePrices
Type:
object
Sale volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
Sale volume price of the product in plg1
-
plg2(optional):
number
Sale volume price of the product in plg2
Nested Schema : variantValuesOrder
Type:
object
Object having various variant property as key and ordered values array as the value.
Show Source
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
-
active(optional):
boolean
The active property of the product
-
avgCustRating(optional):
number
average customer rating for the product
-
brand(optional):
string
brand of the product
-
configurable(optional):
boolean
whether the product is configurable or not
-
CountryOfOrigin(optional):
string
the country of origin of the product
-
defaultProductListingSku(optional):
object defaultProductListingSku
default SKU for the 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
-
displayName(optional):
string
The display name of the product
-
fractionalQuantitiesAllowed(optional):
boolean
Whether fractional quantities are allowed
-
fullImageURLs(optional):
array fullImageURLs
full image url paths
-
height(optional):
number
height of the product
-
id(optional):
string
id of the product
-
largeImageURLs(optional):
array largeImageURLs
The array of large image URLs
-
length(optional):
number
length of the product
-
listPrice(optional):
number
list price of the product
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
listVolumePrice(optional):
number
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
list volume prices of the product in respective price list groups
-
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
Whether the product is not for individual sale
-
onlineOnly(optional):
boolean
online only property
-
orderLimit(optional):
string
the order limit of the product
-
parentCategory(optional):
string
parent category of the product
-
primaryFullImageURL(optional):
string
primary full image url path
-
primaryImageAltText(optional):
string
Alternate text for the primary image of the product
-
primaryImageTitle(optional):
string
primary image title of the product
-
primaryLargeImageURL(optional):
string
primary large image url path
-
primaryMediumImageURL(optional):
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL(optional):
string
Primary Small Image URL of product
-
primarySourceImageURL(optional):
string
primary source image url path
-
primaryThumbImageURL(optional):
string
primary thumb image url path
- relatedProducts(optional): string
-
repositoryId(optional):
string
repository id of the product
-
route(optional):
string
route of the product
-
salePrice(optional):
number
The sale price of the product
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
saleVolumePrice(optional):
number
The sale volume price
-
saleVolumePrices(optional):
object saleVolumePrices
Sale volume prices of the product in respective price list groups
-
seoUrlSlugDerived(optional):
string
Derived from seoUrlSlug of the product if available, else derived from display name of the product.
-
shippingSurcharge(optional):
number
Extra handling costs for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImageURLs(optional):
array smallImageURLs
The urls of the small image.
-
sourceImageURLs(optional):
array sourceImageURLs
source image urls of the product
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of product
-
type(optional):
string
type of the product
-
unitOfMeasure(optional):
string
unit of measure of the product
-
weight(optional):
number
weight
-
width(optional):
number
width of the product
Nested Schema : defaultProductListingSku
Type:
object
default SKU for the product
Nested Schema : listPrices
Type:
object
list prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : listVolumePrices
Type:
object
list volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list volume price of the product in plg1
-
plg2(optional):
number
list volume price of the product in plg2
Nested Schema : salePrices
Type:
object
sale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : saleVolumePrices
Type:
object
Sale volume prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
Sale volume price of the product in plg1
-
plg2(optional):
number
Sale volume price of the product in plg2
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The name of the option.
-
optionValue(optional):
string
The value of the option.
Example Response (application/json)
{
"dynamicPropertyMapLong":{
"sku-MensApparel_color":6,
"sku-MensApparel_size":0
},
"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,
"listVolumePrice":null,
"listPrices":{
"defaultPriceGroup":null
},
"configurationMetadata":[
],
"largeImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940"
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"derivedSalePriceFrom":"UsDollar",
"model":null,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/skus/sku30043"
}
],
"barcode":null,
"salePriceEndDate":null,
"images":[
{
"path":"/products/ACC_TerryGloves_full.jpg",
"metadata":{
},
"name":"/products/ACC_TerryGloves_full.jpg",
"repositoryId":"m10002",
"url":"http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
"tags":[
]
}
],
"unitOfMeasure":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475",
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100"
],
"size":"Small",
"mediumImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=475&width=475"
],
"primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"
],
"productFamily":null,
"primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=100&width=100",
"color":"Gray",
"nonreturnable":false,
"displayName":"sku30043",
"salePrices":{
"defaultPriceGroup":599
},
"primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg",
"productListingSku":true,
"primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=940&width=940",
"smallImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg&height=300&width=300"
],
"thumbnailImage":null,
"discountable":true,
"saleVolumePrices":{
"defaultPriceGroup":null
},
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":null,
"salePrice":null,
"fullImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/ACC_TerryGloves_full.jpg"
],
"soldAsPackage":false,
"repositoryId":"sku30043",
"derivedListPriceFrom":"UsDollar",
"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