listSkus
get
/ccadmin/v1/skus
List Skus. Gets a list of SKUs and its properties. Optionally, search for SKUs in the given catalog by performing a case-insensitive, partial-match on the display name or ID. Optionally, filtered by 'q' parameter. Optionally, takes the x-ccasset-language header to get translated content in another language.
To get the list of SKUs by SKU ids, use skuIds parameter.
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
ID of the catalog.
-
expand(optional): boolean
Boolean indicating whether to return a larger set of SKU properties. Default value is false.
-
includePrices(optional): boolean
Boolean flag to determine whether to include price maps for the skus in the response. Default value is true.
-
itemTypeList(optional): string
Type of sku list associated with the given promotion id -includedSkus or excludedSkus
-
name(optional): string
Partial displayName or id of a SKU to use for search.
-
pageResults(optional): boolean
Return response with paginated pattern, to be used with query param skuIds or promotion group {promotionId, itemTypeList, templateValue}. Default value is false.
-
priceListGroupId(optional): string
Price list group id for adding the prices to the SKU in the response.
-
promotionId(optional): string
The promotion id for the included/excluded SKUs list. If promotionId is included then include the itemTypeList and templateValue parameters to get the include/exclude sku list for the promotion
-
q(optional): string
Contains SCIM query language
-
showInactiveSkus(optional): boolean
Boolean flag to determine whether to include inactive SKUs as part of the result. Default value is true.
-
showSkuBundles(optional): boolean
Boolean flag to determine whether to include SKU bundles as part of the result. Default value is true.
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response. Default value is false.
-
skuIds(optional): string
SKU IDs to list.
-
templateValue(optional): string
UI Template value associated with the included/excluded SKUs list - e.g PSC_Value, optional_offer_psc_value etc
-
withPrices(optional): boolean
Boolean flag to determine whether prices will be returned or not; not returning prices will skip performing any price lookup for the SKUs. Default is true. Setting this to false will supersede 'includePrices'.
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 : listSkus_response
Type:
Show Source
object
-
items(optional):
array items
Array having various SKUs.
-
limit(optional):
integer
Limit of number of products.
-
offset(optional):
integer
Offset of product inventory.
-
sort(optional):
array sort
Array having the order and property of product.
-
total(optional):
integer
Total number of products. Deprecated.
-
totalResults(optional):
integer
Total number of products.
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.
-
dynamicPropertyMapBigString(optional):
string
Dynamic Property MapBigString.
-
dynamicPropertyMapLong(optional):
integer
Dynamic property map long of the SKU.
-
fullImageURLs(optional):
string
Full image URL.
-
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):
string
Medium image URL.
-
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.
-
primaryMediumImageURL(optional):
string
Primary medium image URL.
-
primarySmallImageURL(optional):
string
Primary small image URL.
-
primarySourceImageURL(optional):
string
Primary source image URL.
-
primaryThumbImageURL(optional):
string
Primary thumb image URL.
-
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):
string
Small image URL.
-
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):
string
Source image URL.
-
thumbImageURLs(optional):
string
Thumb image URL.
-
thumbnailImage(optional):
string
Thumbnail image of the SKU.
-
unitOfMeasure(optional):
string
unitOfMeasure
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 1
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.
-
path(optional):
string
Path of the image.
-
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 the image.
-
titleText(optional):
string
Title text for the 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 1
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 : items
Type:
Show Source
object
-
order(optional):
string
Order of listing in product inventory.
-
property(optional):
string
Display name as a product property.
Example Response (application/json)
{
"total":4,
"totalResults":4,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/skus?name=sku1000&pageResults=true"
}
],
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":199.99
},
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":"200000001995",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku10005",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":199.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":199.99
},
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":"200000002008",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku10007",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":199.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":9.99
},
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":"200000002015",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku10008",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":9.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":{
"defaultPriceGroup":null
},
"primaryFullImageURL":null,
"listPrices":{
"defaultPriceGroup":19.99
},
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":{
"defaultPriceGroup":null
},
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"model":null,
"thumbnailImage":null,
"discountable":true,
"barcode":"200000002022",
"saleVolumePrices":{
"defaultPriceGroup":null
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":null,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"sku10009",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
]
}
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|
|------------------|------------------|
|20038|Cannot build the query.|
|20144|Cannot get catalog view.|
|20055|The SKU view does not support queries containing parameters.|
|25013|price List InternalError|
|200105|Catalog not found in the repository|
|200104|Catalog ID is invalid or not associated with current profile.|
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