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: 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: string
Restrict the response to just products in the given category id.
-
continueOnMissingProduct: string
boolean flag to determine whether to continue if a product is missing.
-
includeChildSKUsListingIds: boolean
Boolean indicating whether the child SKU listing ID is required to included or not.
-
name: string
Partial displayName of a product to use for search.
-
productIds: string
Product IDs to list.
-
secondaryCurrencyCode: string
In case of mix currency, if secondaryCurrencyCode is getting passed, secondaryCurrencyShippingSurcharge will be calculated according to secondaryCurrencyCode
-
showInactiveSkus: boolean
Return inactive skus only if its value is true
-
showQuantity: string
Show inventory quantity.
-
showTranslations: boolean
Boolean indicating if the translations property should be returned for each item in the response.
-
storePriceListGroupId: string
the price list group id for which product prices are to be returned
-
unassigned: string
Restrict response to unassigned products (ignore categoryId).
-
verifyCatalog: boolean
Boolean flag to determine whether to verify if a product belongs to the current catalog.
Header Parameters
-
x-ccsite: 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:
array items
Array having various products.
-
limit:
integer
Limit of number of products.
-
offset:
integer
Offset of product inventory.
-
sort:
array sort
Array having the order and property of product.
-
total:
integer
Total number of products. Deprecated.
-
totalResults:
integer
Total number of products.
Nested Schema : items
Type:
Show Source
object-
addOnProducts:
array addOnProducts
Array of AddOn products.
-
avgCustRating:
string
Average customer rating of the product.
-
childSKUs:
array childSKUs
Array having various properties of child SKU.
-
derivedListPriceFrom:
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:
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:
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:
string
Description of the product.
-
displayName:
string
Display name of the product.
-
fullImageURLs:
array fullImageURLs
Full image URLs of the product.
-
id:
string
ID of the product.
-
largeImage:
object largeImage
Array having repository ID and URL of the large image of SKU.
-
largeImageURLs:
array largeImageURLs
Large image URLs of the product.
-
lastModifiedDate:
string
Date and timestamp when the item is modified recently.
-
listPrice:
number
List price of the product in the default price group.
-
listPrices:
object listPrices
Object with price group IDs as keys and list prices as values.
-
longDescription:
string
Long description of the product.
-
mediumImageURLs:
array mediumImageURLs
Medium image URLs of the product.
-
minOrderLimit:
string
Minimum Order limit of the product.
-
nonreturnable:
boolean
Tells whether the product is returnable or not
-
onlineOnly:
boolean
Tells whether the product is online.
-
orderLimit:
string
Maximum Order limit of the product.
-
primaryFullImageURL:
string
Primary full image URL of the product.
-
primaryLargeImageURL:
string
Primary large image URL of the product.
-
primaryMediumImageURL:
string
Primary medium image URL of the product.
-
primarySmallImageURL:
string
Primary small image URL of the product.
-
primarySourceImageURL:
string
Primary source image URL of the product.
-
primaryThumbImageURL:
string
Primary thumb image URL of the product.
-
productImages:
array productImages
Array of product images.
-
productNumber:
string
Product number of the product.
-
productVariantOptions:
array productVariantOptions
Objects containing product's variant options details if available for the product.
-
repositoryId:
string
Repository id of the product.
-
route:
string
Route of the product.
-
salePrice:
number
Sale price of the product in the default price group.
-
salePrices:
object salePrices
Object with price group IDs as keys and sale prices as values.
-
secondaryCurrencyShippingSurcharge:
string
In case of mix currency, if secondaryCurrencyCode is sent in request, shipping amount will be calculated according to given secondaryCurrencyCode. Else if payShippingInSecondaryCurrency flag is enabled in site repository, shipping amount will be calculated according to site level secondaryCurrencyCode
-
shippingSurcharge:
number
Extra handling cost while shipping the product, in the default price group.
-
shippingSurcharges:
object shippingSurcharges
Object with price group IDs as keys and shipping surcharges as values.
-
smallImage:
object smallImage
Array having repository ID and URL of small image of the SKU.
-
smallImageURLs:
string
Small image URLs of the product.
-
sourceImageURLs:
array sourceImageURLs
Source image URLs of the product.
-
thumbImageURLs:
array thumbImageURLs
Thumb image URLs of the product.
Nested Schema : addOnProducts
Type:
arrayArray of AddOn products.
Show Source
-
Array of:
object items
AddOn product.
Nested Schema : largeImage
Type:
objectArray having repository ID and URL of the large image of SKU.
Show Source
-
repositoryId:
string
Repository ID of SKU.
-
url:
string
URL of SKU.
Nested Schema : listPrices
Type:
objectObject with price group IDs as keys and list prices as values.
Show Source
-
Price Group ID 1:
number
List price of product in price group 1.
-
Price Group ID 2:
number
List price of product in price group 2.
Nested Schema : productVariantOptions
Type:
arrayObjects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type:
objectObject with price group IDs as keys and sale prices as values.
Show Source
-
Price Group ID 1:
number
Sale price of product in price group 1.
-
Price Group ID 2:
number
Sale price of product in price group 2.
Nested Schema : shippingSurcharges
Type:
objectObject with price group IDs as keys and shipping surcharges as values.
Show Source
-
Price Group ID 1:
number
Shipping surcharge of product in price group 1.
-
Price Group ID 2:
number
Shipping surcharge of product in price group 2.
Nested Schema : smallImage
Type:
objectArray having repository ID and URL of small image of the SKU.
Show Source
-
repositoryId:
string
Repository ID of SKU.
-
url:
string
URL of SKU.
Nested Schema : items
Type:
objectAddOn product.
Show Source
-
configurationOptions:
array configurationOptions
Array of configuration options.
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of configurable product.
Nested Schema : items
Type:
Show Source
object-
id:
string
Repository ID
-
product:
object product
Product Details
-
repositoryId:
string
Repository ID of configuration option.
-
sku:
object sku
Sku Details
Nested Schema : product
Type:
objectProduct Details
Show Source
-
displayName:
string
Display name of product.
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of product.
-
type:
string
Type of product.
Nested Schema : sku
Type:
objectSku Details
Show Source
-
id:
string
Repository ID
-
repositoryId:
string
Repository ID of sku.
Nested Schema : items
Type:
Show Source
object-
configurationMetadata:
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedListPriceFrom:
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:
boolean
Indicates if the SKU is available online or not.
-
derivedSalePriceFrom:
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:
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
-
dynamicPropertyMapLong:
integer
Dynamic property map long of the SKU.
-
DynamicSKUProperty:
string
Dynamic Properties of SKU.
-
fullImageURLs:
array fullImageURLs
Full Image URLs of SKU.
-
id:
string
SKU id
-
largeImage:
integer
Large image of the SKU.
-
largeImageURLs:
array largeImageURLs
Large Image URLs of SKU.
-
lastModifiedDate:
string
Date and timestamp when the item is modified recently.
-
listingSKUId:
string
It contains listing variant's repository id, this field will be available if query param has includeChildSKUsListingIds as true and if product is style based one.
-
listPrice:
integer
List price of the SKU.
-
mediumImageURLs:
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable:
boolean
Tells whether the sku is returnable or not
-
primaryLargeImageURL:
string
Primary Large Image URL of SKU.
-
primaryMediumImageURL:
string
Primary Medium Image URL ID of SKU.
-
primarySmallImageURL:
string
Primary Small Image URL of SKU.
-
primarySourceImageURL:
string
Primary Source Image URL of SKU.
-
primaryThumbImageURL:
string
Primary Source Image URL of SKU.
-
quantity:
integer
Quantity of the SKU.
-
repositoryId:
string
Repository ID of the SKU.
-
salePrice:
string
Sale price of the SKU.
-
salePriceEndDate:
integer
Sale price end date of the SKU.
-
salePriceStartDate:
string
Sale price start date of the SKU.
-
shippingSurcharge:
integer
Extra handling costs while shipping the product.
-
shippingSurcharges:
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage:
integer
Small image of the SKU.
-
smallImageURLs:
array smallImageURLs
Small Image URLs of SKU.
-
sourceImageURLs:
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs:
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage:
string
Thumbnail image of the SKU.
Nested Schema : configurationMetadata
Type:
arrayArray of configuration attributes associated with the SKU.
Show Source
Nested Schema : shippingSurcharges
Type:
objectExtra handling costs for shipping the product in respective price list groups
Show Source
-
plg1:
number
Extra handling costs for shipping the product in plg1
-
plg2:
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object-
name:
string
The name of the configuration attribute.
-
repositoryId:
string
The repository id for existing configuration metadata items.
-
value:
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object-
metadata:
object metadata
Seo meta info for product.
-
name:
string
The name of product image
-
path:
string
The path of the image
-
repositoryId:
string
The repository Id of the product image
-
tags:
array tags
The array of product image tags
-
url:
string
The url of the product image
Nested Schema : metadata
Type:
objectSeo meta info for product.
Show Source
-
altText:
string
The alt text of the image
-
titleText:
string
The title text of the image
Nested Schema : items
Type:
Show Source
object-
listingVariant:
boolean
Whether listing should be done based on this variant.
-
mapKeyPropertyAttribute:
string
map key property
-
optionId:
string
option Id
-
optionName:
string
option Name
-
optionValueMap:
object optionValueMap
Additional Properties Allowed: additionalPropertiesmapping of all option values with corresponding option value ids
-
variantBasedDisplay:
boolean
Whether this variant based display should be allowed.
Nested Schema : optionValueMap
Type:
objectAdditional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
-
optionValue:
string
Option Value
-
optionValueId:
integer
Option Value Id
Nested Schema : items
Type:
Show Source
object-
order:
string
Order of listing in product inventory.
-
property:
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":[
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":null,
"configurationMetadata":[
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxy",
"barcode":"200000000134",
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"saleVolumePrices":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":15,
"salePrice":4.99,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxy",
"shippingSurcharge":null,
"listPrice":12.99,
"configurable":false
},
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":null,
"configurationMetadata":[
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_19Dxyi",
"barcode":"200000000141",
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"saleVolumePrices":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":15,
"salePrice":null,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxyi",
"shippingSurcharge":null,
"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,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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",
"shippingSurcharge":null,
"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,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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",
"shippingSurcharge":null,
"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,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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",
"shippingSurcharge":null,
"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,
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"lastModifiedDate":"2023-01-31T05:10:45.075Z",
"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"
],
"minOrderLimit":1,
"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"
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"id":"Product_11D",
"filteredSKUs":[
{
"dynamicPropertyMapLong":{
},
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"listPrices":null,
"configurationMetadata":[
],
"largeImageURLs":[
],
"productLine":null,
"listVolumePrices":null,
"derivedSalePriceFrom":"defaultPriceGroup",
"model":null,
"id":"Sku_11E",
"barcode":"200000000028",
"salePriceEndDate":null,
"images":[
],
"unitOfMeasure":null,
"primaryMediumImageURL":null,
"dynamicPropertyMapBigString":{
},
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"productFamily":null,
"primaryThumbImageURL":null,
"nonreturnable":false,
"displayName":null,
"salePrices":null,
"primaryFullImageURL":null,
"productListingSku":null,
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"thumbnailImage":null,
"saleVolumePrices":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"quantity":3,
"salePrice":10.99,
"fullImageURLs":[
],
"variantValuesOrder":{
},
"repositoryId":"Sku_11E",
"derivedListPriceFrom":"defaultPriceGroup",
"shippingSurcharge":null,
"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":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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,
"shippingSurcharge":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":19.99,
"configurable":false
}
],
"lastModifiedDate":"2023-01-31T05:10:45.075Z",
"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",
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v4248266855026120653/products/absurdistan_LARGE.jpg&height=300&width=300",
"shippingSurcharge":null,
"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"
],
"minOrderLimit":1,
"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":{
"defaultPriceGroup":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":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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,
"shippingSurcharge":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":[
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"shippingSurcharges":{
"defaultPriceGroup":null
},
"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,
"shippingSurcharge":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":24.99,
"configurable":false
}
],
"lastModifiedDate":"2023-01-31T05:10:45.075Z",
"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",
"primarySourceImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300",
"shippingSurcharge":null,
"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"
],
"minOrderLimit":1,
"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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code