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(required): string
The skuId.
Query Parameters
-
includePrices: boolean
Boolean flag to determine whether to include price maps for the skus in the response.
-
priceListGroupId: string
Price list group id for adding the prices to the SKU in the response.
Header Parameters
-
X-CCAsset-Language: 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
-
items:
object items
sku details with pricing and variant information
Nested Schema : items
Type:
object
sku details with pricing and variant information
Show Source
-
configurable:
boolean
Indicates whether SKU is configurable
-
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
-
derivedOnlineOnly:
boolean
Indicates if the SKU is available online or not.
-
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
-
displayName:
string
The display name of the SKU
-
largeImage:
object largeImage
large image
-
listPrice:
integer
List price of the SKU.
-
parentProducts:
object parentProducts
Array having parent products.
-
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.
-
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:
object smallImage
Small image of Sku
-
thumbnailImage:
string
Thumbnail image of the SKU.
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : largeImage
Type:
object
large image
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : parentProducts
Type:
object
Array having parent products.
Show Source
-
active:
boolean
Flag indicating whether a product is active
-
addOnProducts:
array addOnProducts
Array of AddOn products.
-
avgCustRating:
string
Average customer rating of the product.
-
childSKUs:
object childSKUs
Array having properties of child 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
-
description:
string
Description of the product.
-
displayName:
string
Display name of the product.
-
fullImageURLs:
array fullImageURLs
Full image URLs of the product.
-
id:
string
ID of the product.
-
largeImage:
object largeImage
Array having repository ID and URL of the large image of SKU.
-
largeImageURLs:
array largeImageURLs
Large image URLs of the product.
-
listPrice:
number
List price of the product.
-
listVolumePrice:
number
List volume price of the product.
-
longDescription:
string
Long description of the product.
-
mediumImageURLs:
array mediumImageURLs
Medium image URLs of the product.
-
minOrderLimit:
string
Minimum Order limit of the product.
-
onlineOnly:
boolean
online only property
-
orderLimit:
string
Maximum Order limit of the product.
-
primaryFullImageURL:
string
Primary full image URL of the product.
-
primaryLargeImageURL:
string
Primary large image URL of the product.
-
primarySmallImageURL:
string
Primary small image URL of the product.
-
primarySourceImageURL:
string
Primary source image URL of the product.
-
primaryThumbImageURL:
string
Primary thumb image URL of the product.
-
productImages:
array productImages
Array of product images.
-
productNumber:
string
Product number of the product.
-
repositoryId:
string
Repository id of the product.
-
route:
string
Route of the product.
-
salePrice:
integer
Sale price of the product.
-
saleVolumePrice:
number
Sale volume price of the product.
-
smallImage:
object smallImage
Array having repository ID and URL of small image of the SKU.
-
smallImageURLs:
array smallImageURLs
Small image URLs of the product.
-
sourceImageURLs:
array sourceImageURLs
Source image URLs of the product.
-
thumbImageURLs:
array thumbImageURLs
Thumb image URLs of the product.
Nested Schema : shippingSurcharges
Type:
object
Extra 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 : smallImage
Type:
object
Small image of Sku
Show Source
-
repositoryId:
string
repository Id
-
url:
string
URL
Nested Schema : items
Type:
Show Source
object
-
name:
string
The name of the configuration attribute.
-
repositoryId:
string
The repository id for existing configuration metadata items.
-
value:
string
The value of the configuration attribute.
Nested Schema : addOnProducts
Type:
array
Array of AddOn products.
Show Source
-
Array of:
object items
AddOn product.
Nested Schema : childSKUs
Type:
object
Array having properties of child SKU.
Show Source
-
repositoryId:
string
Repository ID of the SKU.
Nested Schema : largeImage
Type:
object
Array having repository ID and URL of the large image of SKU.
Show Source
-
repositoryId:
string
Repository ID of SKU.
-
url:
string
URL of SKU.
Nested Schema : smallImage
Type:
object
Array having repository ID and URL of small image of the SKU.
Show Source
-
repositoryId:
string
Repository ID of SKU.
-
url:
string
URL of SKU.
Nested Schema : items
Type:
object
AddOn product.
Show Source
-
configurationOptions:
array configurationOptions
Array of configuration options.
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of configurable product.
Nested Schema : items
Type:
Show Source
object
-
id:
string
Repository ID
-
product:
object product
Product Details
-
repositoryId:
string
Repository ID of configuration option.
-
sku:
object sku
Sku Details
Nested Schema : product
Type:
object
Product Details
Show Source
-
displayName:
string
Display name of product.
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of product.
-
type:
string
Type of product.
Nested Schema : sku
Type:
object
Sku Details
Show Source
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of sku.
Nested Schema : items
Type:
Show Source
object
-
metadata:
object metadata
Seo meta info for product.
-
name:
string
The name of product image
-
path:
string
The path of the image
-
repositoryId:
string
The repository Id of the product image
-
tags:
array tags
The array of product image tags
-
url:
string
The url of the product image
Nested Schema : metadata
Type:
object
Seo meta info for product.
Show Source
-
altText:
string
The alt text of the image
-
titleText:
string
The title text of the image
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"
],
"derivedShippingSurchargeFrom":"UsDollar",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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",
"shippingSurcharge":null,
"listPrice":null,
"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:
array
An 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