listProducts
get
/ccagent/v1/products
List Products. Gets a list of products. Optionally search for products in the given catalog and collection whose display name CONTAINS IGNORECASE the given search string. Optionally takes the x-ccasset-language header to get translated content in another language. 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 data specific to the site
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
ID of the 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.
-
categoryId(optional): string
Restrict the response to just products in the given category id.
-
continueOnMissingProduct(optional): string
boolean flag to determine whether to continue if a product is missing.
-
includeChildSKUsListingIds(optional): boolean
Boolean indicating whether the child SKU listing ID is required to included or not.
-
name(optional): string
Partial displayName of a product to use for search.
-
productIds(optional): string
Product IDs to list.
-
secondaryCurrencyCode(optional): string
In case of mix currency, if secondaryCurrencyCode is getting passed, secondaryCurrencyShippingSurcharge will be calculated according to secondaryCurrencyCode
-
showInactiveSkus(optional): boolean
Return inactive skus only if its value is true
-
showQuantity(optional): string
Show inventory quantity.
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response.
-
storePriceListGroupId(optional): string
the price list group id for which product prices are to be returned
-
unassigned(optional): string
Restrict response to unassigned products (ignore categoryId).
-
verifyCatalog(optional): boolean
Boolean flag to determine whether to verify if a product belongs to the current catalog.
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 : listProducts_response
Type:
Show Source
object-
items(optional):
array items
Array having various products.
-
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-
addOnProducts(optional):
array addOnProducts
The array of add-on product groups
-
avgCustRating(optional):
string
Average customer rating of the product.
-
brand(optional):
string
Brand of the product.
-
childSKUs(optional):
array childSKUs
Array having various properties of child SKU.
-
coreProduct(optional):
boolean
Flag specifying if this is a core product that should automatically be a member of filtered view catalogs (unless specifically excluded)
-
creationDate(optional):
string
Creation date of 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
Display name of the product.
-
fullImageURLs(optional):
array fullImageURLs
Full image URLs of the product.
-
id(optional):
string
ID of the product.
-
isFilteredCatalogMember(optional):
boolean
Flag specifying if this product is a member of the filtered view catalog in context. This field only appears if the request query parameter includeBaseCatalogProducts=true
-
largeImage(optional):
object largeImage
Array having repository ID and URL of the large image of SKU.
-
largeImageURLs(optional):
array largeImageURLs
Large image URLs of the product.
-
listPrice(optional):
number
List price of the product in the default price group.
-
listVolumePrice(optional):
object listVolumePrice
list volume price of the product
-
listVolumePrices(optional):
object listVolumePrices
Object with price group IDs as keys and list prices as values
-
longDescription(optional):
string
Long description of the product.
-
mediumImageURLs(optional):
array mediumImageURLs
Medium image URLs of the product.
-
orderLimit(optional):
string
Order limit of the product.
-
primaryFullImageURL(optional):
string
Primary full image URL of the product.
-
primaryLargeImageURL(optional):
string
Primary large image URL of the product.
-
primaryMediumImageURL(optional):
string
Primary medium image URL of the product.
-
primarySmallImageURL(optional):
string
Primary small image URL of the product.
-
primarySourceImageURL(optional):
string
Primary source image URL of the product.
-
primaryThumbImageURL(optional):
string
Primary thumb image URL of the product.
-
productImages(optional):
array productImages
Array of product images.
-
repositoryId(optional):
string
Repository id of the product.
-
route(optional):
string
Route of the product.
-
salePrice(optional):
number
Sale price of the product in the default price group.
-
saleVolumePrice(optional):
object saleVolumePrice
Sale volume price of the product
-
saleVolumePrices(optional):
object saleVolumePrices
Object with price group IDs as keys and sale volume prices as values
-
shippingSurcharge(optional):
number
Extra handling cost while shipping the product, in the default price group.
-
smallImage(optional):
object smallImage
Array having repository ID and URL of small image of the SKU.
-
smallImageURLs(optional):
array smallImageURLs
Small image URLs of the product.
-
sourceImageURLs(optional):
array sourceImageURLs
Source image URLs of the product.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb image URLs of the product.
Nested Schema : largeImage
Type:
objectArray having repository ID and URL of the large image of SKU.
Show Source
-
repositoryId(optional):
string
Repository ID of SKU.
-
url(optional):
string
URL of SKU.
Nested Schema : listVolumePrice
Type:
objectlist volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
objectObject with price group IDs as keys and list prices as values
Show Source
-
priceGroupId1(optional):
object priceGroupId1
List price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
List price of the product in price group 1
Nested Schema : saleVolumePrice
Type:
objectSale volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
objectObject with price group IDs as keys and sale volume prices as values
Show Source
-
priceGroupId1(optional):
object priceGroupId1
List price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
List price of the product in price group 1
Nested Schema : smallImage
Type:
objectArray having repository ID and URL of small image of the SKU.
Show Source
-
repositoryId(optional):
string
Repository ID of SKU.
-
url(optional):
string
URL of SKU.
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.
-
bundleLinks(optional):
array bundleLinks
Array of bundle links associated with the SKU
-
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
-
dynamicPropertyMapLong(optional):
integer
Dynamic property map long of the SKU.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of 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 product
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Indicates whether the SKU is returnable or not.
-
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 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 Source Image URL of SKU.
-
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 product
-
shippingSurcharge(optional):
number
Extra handling costs while shipping the product.
-
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.
Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrice
Type:
objectlist volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
Type:
objectSale volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
The id of 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 : pricingScheme
Type:
objectPricing 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:
objectPricing 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:
objectPricing 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:
objectList price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
objectList price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing 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:
objectPricing 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-
metadata(optional):
object metadata
Seo meta info for product.
-
name(optional):
string
The name of product image
-
path(optional):
string
The path of the image
-
repositoryId(optional):
string
The repository Id of the product image
-
tags(optional):
array tags
The array of product image tags
-
url(optional):
string
The url of the product image
Nested Schema : metadata
Type:
objectSeo meta info for product.
Show Source
-
altText(optional):
string
The alt text of the image
-
titleText(optional):
string
The title text of the image
Nested Schema : pricingScheme
Type:
objectPricing 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:
objectList price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
objectList price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing 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:
objectPricing 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)
{
"totalResults":3,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/products?delegatedAdminAllowedThroughAgent=true&orderApprovalsAllowedThroughAgent=true"
}
],
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"longDescription":"It's Samantha Baker's Sweet Sixteen and no one in her family remembers\n the important occasion. John Hughes, the writer of National Lampoon's Vacation, shows how coming-of-age\n can be full of surprises in this warm-hearted teenage comedy starring Molly Ringwald. She's your average\n teen, enduring creepy freshmen, spoiled siblings, confused parents and the Big Blonde on Campus who\n stands between her and the boy of her dreams. But wait...the day isn't over yet! This sparkling film\n features a dynamic score, and outstanding performances by Paul Dooley, Emmy winner Blanche Baker and\n Oscar nominee Justin Henry.\n ",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"nonreturnable":false,
"displayName":"16 Candles",
"orderLimit":null,
"onlineOnly":true,
"description":"A really great movie that you should not miss.",
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg",
"type":null,
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_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"
}
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300"
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"id":"Product_19Cxy",
"filteredSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxy",
"thumbnailImage":null,
"barcode":"200000000134",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":4.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxy",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":12.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxyi",
"thumbnailImage":null,
"barcode":"200000000141",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxyi",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxyii",
"thumbnailImage":null,
"barcode":"200000000158",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":8.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxyii",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"childSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":false,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxy",
"thumbnailImage":null,
"barcode":"200000000134",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":4.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxy",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":12.99,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxyi",
"thumbnailImage":null,
"barcode":"200000000141",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxyi",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null,
"configurable":false
},
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxyii",
"thumbnailImage":null,
"barcode":"200000000158",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":15,
"unitOfMeasure":null,
"salePrice":8.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxyii",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"salePrice":8.99,
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=475&width=475",
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=100&width=100"
],
"productImages":[
{
"path":"/products/sixteen_candles_LARGE.jpg",
"metadata":{
},
"repositoryId":"m470131",
"name":"16 Candles Image - Large",
"url":"http://localhost:9080/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg",
"tags":[
]
}
],
"variantValuesOrder":{
},
"route":"/16-candles/product/Product_19Cxy",
"notForIndividualSale":false,
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=475&width=475"
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Product_19Cxy",
"shippingSurcharge":null,
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/v5420730269231405246/products/sixteen_candles_LARGE.jpg&height=300&width=300"
],
"avgCustRating":4.5,
"listPrice":19.99,
"configurable":false
},
{
"longDescription":null,
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"nonreturnable":false,
"displayName":"Absurdistan",
"orderLimit":100,
"description":"Not really serious",
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg",
"type":null,
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=940&width=940",
"smallImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300"
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"id":"Product_11D",
"filteredSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_11E",
"thumbnailImage":null,
"barcode":"200000000028",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":3,
"unitOfMeasure":null,
"salePrice":10.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"mediumImageURLs":[
],
"repositoryId":"Sku_11E",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"childSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":false,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_11E",
"thumbnailImage":null,
"barcode":"200000000028",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":3,
"unitOfMeasure":null,
"salePrice":10.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"Sku_11E",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"salePrice":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=475&width=475",
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=100&width=100"
],
"productImages":[
{
"path":"/products/absurdistan_LARGE.jpg",
"metadata":{
},
"repositoryId":"m470133",
"name":"Absurdistan Image - Large",
"url":"http://localhost:9080/file/v4248266855026120653/products/absurdistan_LARGE.jpg",
"tags":[
]
}
],
"variantValuesOrder":{
},
"route":"/absurdistan/product/Product_11D",
"notForIndividualSale":false,
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=475&width=475"
],
"repositoryId":"Product_11D",
"derivedListPriceFrom":"defaultPriceGroup",
"shippingSurcharge":null,
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300"
],
"avgCustRating":4,
"listPrice":19.99,
"configurable":false
},
{
"longDescription":"Akira isn???t just a movie ??? it???s the genesis of a genre. Katsuhiro\n Otomo???s landmark cyberpunk classic obliterated the boundaries of Japanese animation and forced the world\n to look into the future. Akira???s arrival shattered traditional thinking, creating space for movies like\n the The Matrix to be dreamed into brutal reality. Without Kaneda and Tetsuo, without espers and psionic\n assassins, without that badass motorcycle ??? our world would be a far less exciting place to exist. But\n the manga became the movie and the movie became a phenomenon and the world took notice. Now, Akira is\n everywhere. If you can???t see it in the streets ??? if you can???t feel it crawling around inside your brain\n ??? then you have yet to be initiated. What. Are. You. Waiting. For?\n ",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"nonreturnable":false,
"displayName":"Akira",
"orderLimit":null,
"description":"A really great movie that you should not miss.",
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg",
"type":null,
"largeImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940",
"smallImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"id":"Product_27Fxyzi",
"filteredSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_27Gxyzi",
"thumbnailImage":null,
"barcode":"200000000295",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":7,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"variantValuesOrder":{
},
"mediumImageURLs":[
],
"repositoryId":"Sku_27Gxyzi",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":24.99,
"configurable":false
}
],
"childSKUs":[
{
"productFamily":null,
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"listPrices":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":false,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_27Gxyzi",
"thumbnailImage":null,
"barcode":"200000000295",
"saleVolumePrices":null,
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":7,
"unitOfMeasure":null,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"Sku_27Gxyzi",
"derivedListPriceFrom":"defaultPriceGroup",
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":24.99,
"configurable":false
}
],
"salePrice":null,
"primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475",
"fullImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100"
],
"productImages":[
{
"path":"/products/akira_LARGE.jpg",
"metadata":{
},
"repositoryId":"m540123",
"name":"Akira Image - Large",
"url":"http://localhost:9080/file/v291840211342511571/products/akira_LARGE.jpg",
"tags":[
]
}
],
"variantValuesOrder":{
},
"route":"/akira/product/Product_27Fxyzi",
"notForIndividualSale":false,
"mediumImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475"
],
"repositoryId":"Product_27Fxyzi",
"derivedListPriceFrom":"defaultPriceGroup",
"shippingSurcharge":null,
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300",
"primarySmallImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300"
],
"avgCustRating":4.5,
"listPrice":24.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|
|------------------|------------------|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|20034|Get ProductList Internal Error|
|25013|price List InternalError|
|20041|Null ProductListingRequest argument passed to method|
|20040|Get Product Type Internal Error|
|10002|Invalid value [ {1} ] for parameter: {0}.|
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:
arrayAn 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