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
The data for the sku.
Nested Schema : items
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)
{
"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