listSkus
get
/ccagent/v1/skus
List Skus. Returns a paginated list of SKUs, including variant options, prices, and inventory. Optionally filtered by 'q' parameter. 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.Additionally takes x-cssite header to return the skus pertaining to the site
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
Catalog Id
-
preFilter(optional): boolean
Enabling this flag would improve response time by applying filter. However for better performance results, include only required properties in filterKey, fields , incldude query parameter and avoid including fields like parentProducts which intern have huge number of fields. While using this property ensure that repositoryId,id,parentProducts.id are always included in the response.
-
q(optional): string
Contains SCIM query language
-
skuIds(optional): string
Comma separated multiple SKU IDS
-
storePriceListGroupId(optional): string
Store PriceList Group 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 : 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":1,
"totalResults":1,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/skus?q=barcode%20eq%20%2212345%22"
}
],
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"dynamicPropertyMapLong":{
"sku-WomensApparel_color":13,
"sku-WomensApparel_size":0
},
"bundleLinks":[
],
"largeImage":null,
"smallImage":null,
"derivedCatalogs":[
{
"repositoryId":"cloudCatalog"
}
],
"endDate":null,
"listPrices":{
"defaultPriceGroup":55
},
"configurationMetadata":[
],
"type":"sku-WomensApparel",
"largeImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"variantOptions":[
[
{
"optionValue":"Poppy",
"optionName":"Color"
},
{
"optionValue":"Small",
"optionName":"Size"
}
]
],
"translations":{
"1":{
"repositoryId":"xsku2535_1_en_US"
},
"27":{
"repositoryId":"xsku2535_1_vi"
}
},
"id":"xsku2535_1",
"barcode":"12345",
"wholesalePrice":null,
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"skuInfos":{
},
"thumbImageURLs":[
],
"creationDate":"2016-05-09T14:54:09.000Z",
"version":4,
"parentProducts":[
{
"longDescription":"Wear this skirt anywhere with anything. Flat front allows shirts to be tucked in or overlaid nicely, side zipper and snap rivet detailing around the waist.",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"displayName":"A-Line Skirt",
"orderLimit":null,
"onlineOnly":false,
"description":"The simple perfect A line",
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.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=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"derivedSalePriceFrom":"defaultPriceGroup",
"id":"xprod2535",
"childSKUs":[
{
"repositoryId":"xsku2535_1"
},
{
"repositoryId":"xsku2535_2"
},
{
"repositoryId":"xsku2535_3"
},
{
"repositoryId":"xsku2535_4"
},
{
"repositoryId":"xsku2535_5"
},
{
"repositoryId":"xsku2535_6"
}
],
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
"salePrice":null,
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=100&width=100"
],
"productImages":[
{
"repositoryId":"img_xprod2535_0"
},
{
"repositoryId":"img_xprod2535_1"
}
],
"route":"/product/xprod2535",
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=475&width=475",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=475&width=475"
],
"repositoryId":"xprod2535",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"shippingSurcharge":null,
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/v2/products/APP_A-lineSkirt_full.jpg&height=300&width=300",
"/ccstore/v1/images/?source=/file/v2/products/APP_SportySkirt_full.jpg&height=300&width=300"
],
"avgCustRating":null,
"listPrice":null
}
],
"size":"Small",
"manufacturer_part_number":null,
"catalogs":[
],
"mediumImageURLs":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"startDate":null,
"template":null,
"primaryThumbImageURL":null,
"replacementProducts":null,
"dynamicAttributes":{
},
"fixedReplacementProducts":[
],
"color":"Poppy",
"nonreturnable":false,
"displayName":"A-Line Skirt",
"description":null,
"primaryFullImageURL":null,
"salePrices":{
"defaultPriceGroup":null
},
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":false,
"smallImageURLs":[
],
"itemAcl":null,
"onSale":false,
"unit_of_measure":null,
"dynamicPropertyMapString":{
},
"siteIds":[
],
"computedCatalogs":[
],
"discountable":true,
"thumbnailImage":null,
"catalogsReplacementProducts":[
],
"salePriceStartDate":null,
"quantity":100,
"salePrice":null,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"soldAsPackage":false,
"auxiliaryMedia":{
},
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"xsku2535_1",
"shippingSurcharge":0,
"fractionalQuantitiesAllowed":false,
"fulfiller":null,
"dynamicPropertyMapDouble":{
},
"configurable":false,
"listPrice":55
}
]
}
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|
|------------------|------------------|
|200020|Invalid query in 'q' parameter.|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|50001|Internal Error.|
|26050|Variants Internal Error.|
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