getSku
get
/ccagent/v1/skus/{id}
Get Sku. Returns sku details with pricing and variant information. Unlike the getSku endpoint of Admin, this endpoint returns pricing and variants details of Sku. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the sku's of that site'
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Sku Id.
Query Parameters
-
catalogId(optional): string
ID of catalog. If a catalogId is not passed, the catalog associated with the shopperProfileId passed in the X-CCAgentContext header is used. If no shopperProfileId is passed in the header, default catalog associated with the site is used.
-
showNotForIndividualSale: boolean
To retrieve not for indivisal Sale items. If showNotForIndividualSale is not passed the sku will return if it exists
-
skuId: string
Sku Id.
Header Parameters
-
x-ccsite(optional): string
the site id on which the orders is laced
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getSku_response
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 Thumb 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)
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagent/v1/variants/camcordersku_1_3"
}
],
"autoWrap":true,
"items":[
{
"dynamicPropertyMapLong":{
"sku-camcorder_zoom":0,
"sku-camcorder_color":2
},
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"endDate":null,
"derivedCatalogs":[
],
"configurationMetadata":[
],
"type":"sku-camcorder",
"derivedSalePriceFrom":"defaultPriceGroup",
"translations":{
},
"id":"camcordersku_1_3",
"wholesalePrice":null,
"salePriceEndDate":null,
"skuInfos":{
},
"creationDate":"2015-03-30T06:53:04.000Z",
"version":1,
"parentProducts":[
{
"longDescription":"Record footage in 720p resolution with this Samsung F980BN\n HMX-F90BN/XAA flash memory camcorder, which features a CMOS sensor to help you capture high-definition\n videos. The 2. LCD display provides a clear view for shooting or reviewing images.\n ",
"primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"listVolumePrice":{
"bulkPrice":{
"numLevels":2,
"levels":[
{
"price":21,
"levelMinimum":1,
"levelMaximum":10
},
{
"price":10,
"levelMinimum":11
}
]
}
},
"displayName":"Samsung - F90BN HD Flash Memory Camcorder",
"orderLimit":null,
"onlineOnly":false,
"description":null,
"primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg",
"largeImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=940&width=940",
"addOnProducts":[
{
"repositoryId":"cp10004",
"configurationOptions":[
{
"product":{
"displayName":"OM-D E-M10 Digital Compact System Camera",
"repositoryId":"camera_1",
"id":"camera_1",
"type":"camera"
},
"repositoryId":"co10009",
"id":"co10009",
"sku":{
"repositoryId":"camerasku_1_1",
"id":"camerasku_1_1"
}
},
{
"product":{
"displayName":"OM-D E-M10 Digital Compact System Camera",
"repositoryId":"camera_1",
"id":"camera_1",
"type":"camera"
},
"repositoryId":"co10010",
"id":"co10010",
"sku":{
"repositoryId":"camerasku_1_2",
"id":"camerasku_1_2"
}
}
],
"id":"cp10004"
},
{
"repositoryId":"cp10005",
"configurationOptions":[
{
"product":{
"displayName":"Movie Gift Card",
"repositoryId":"giftCard_1",
"id":"giftCard_1",
"type":"giftCard"
},
"repositoryId":"co10011",
"id":"co10011",
"sku":{
"repositoryId":"giftCardsku_1",
"id":"giftCardsku_1"
}
}
],
"id":"cp10005"
}
],
"smallImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"derivedSalePriceFrom":"defaultPriceGroup",
"id":"camcorder_1",
"childSKUs":[
{
"repositoryId":"camcordersku_1_1"
},
{
"repositoryId":"camcordersku_1_2"
},
{
"repositoryId":"camcordersku_1_3"
},
{
"repositoryId":"camcordersku_1_4"
}
],
"saleVolumePrice":{
"tieredPrice":{
"numLevels":2,
"levels":[
{
"price":18,
"levelMinimum":1,
"levelMaximum":10
},
{
"price":8,
"levelMinimum":11
}
]
}
},
"salePrice":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475",
"fullImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=100&width=100"
],
"productImages":[
{
"repositoryId":"camcorderImg"
}
],
"route":"/product/camcorder_1",
"mediumImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=475&width=475"
],
"repositoryId":"camcorder_1",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=http://localhost:9080/file/products/Samsung_F90BN_LARGE.jpg&height=300&width=300"
],
"avgCustRating":null,
"listPrice":null
}
],
"manufacturer_part_number":null,
"catalogs":[
],
"startDate":null,
"template":null,
"replacementProducts":null,
"dynamicAttributes":{
},
"fixedReplacementProducts":[
],
"color":"Neon",
"nonreturnable":false,
"displayName":"Camcorder",
"description":null,
"derivedOnlineOnly":false,
"itemAcl":null,
"unit_of_measure":null,
"onSale":false,
"dynamicPropertyMapString":{
},
"siteIds":[
],
"thumbnailImage":null,
"computedCatalogs":[
],
"discountable":true,
"catalogsReplacementProducts":[
],
"salePriceStartDate":null,
"quantity":null,
"salePrice":597,
"zoom":"2x optical/130x digital",
"soldAsPackage":false,
"auxiliaryMedia":{
},
"repositoryId":"camcordersku_1_3",
"derivedListPriceFrom":"defaultPriceGroup",
"fulfiller":null,
"dynamicPropertyMapDouble":{
},
"listPrice":699.99
},
[
{
"optionValue":"Neon",
"optionName":"color"
},
{
"optionValue":"2x optical/130x digital",
"optionName":"zoom"
}
]
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|20033|Illegal to use catalog ID when custom catalogs are not in use.|
|26069|Internal Error.|
|26050|Variants Internal Error.|
|26061|Cannot Find Null Sku.|
|26060|Cannot Find Sku.|
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