listProducts
get
/ccstore/v1/products
List Products. Get a list of products. Optionally takes the x-ccasset-language headers to get translated content in another language.Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization id of logged in user. None of the image URLS are encoded.
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
the catalog ID for the site
-
categoryId(optional): string
the category ID
-
continueOnMissingProduct(optional): boolean
flag to indicate if invalid products has to be ignored. Default value is false.
-
includeChildSKUsListingIds(optional): boolean
If this flag is true then listingVariant repository id will be included in each of the childSKU of style based product
-
includeChildren(optional): boolean
flag to include children of categories or not
-
limit(optional): integer
The number of items per block
-
minimalPrices(optional): boolean
boolean flag defaults to false, set to true if only a price range rather than all prices are required for the response
-
offset(optional): integer
startingIndex the index of the first record to load
-
productIds(optional): string
the list of product IDs
-
q(optional): string
A SCIM filter string for selecting a subset of all products. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Examples: Get all products whose displayName contains shirt: q=displayName co "shirt" Get all products with an orderLimit between 5 and 10: q=orderLimit gt 5 and orderLimit lt 10 Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted. The following base product properties can be used in a q query: * CountryOfOrigin * active * avgCustRating * brand * childSKUs * defaultProductListingSku * derivedDirectCatalogs * description * displayName * height * id * length * longDescription * notForIndividualSale * orderLimit * parentCategories * relatedArticles * relatedMediaContent * type * unitOfMeasure * weight * width Additionally, custom product properties may also be used in a q query.
-
sort(optional): string
Sort Option id: Sort order
-
storePriceListGroupId(optional): string
the price list group id for which product prices are to be returned
-
totalExpandedResults(optional): boolean
flag to include count of total products with listing variant expansion
-
totalResults(optional): boolean
flag to include count of total products without expansion
-
withPrices(optional): boolean
boolean flag defaults to true, set to false if prices are not required in the response
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : 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:
object
Array 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:
object
list volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
Type:
object
Object with price group IDs as keys and list prices as values
Show Source
-
priceGroupId1(optional):
object priceGroupId1
List price of the product in price group 1
-
priceGroupId2(optional):
object priceGroupId2
List price of the product in price group 1
Nested Schema : saleVolumePrice
Type:
object
Sale volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
Type:
object
Object with price group IDs as keys and sale 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:
object
Array 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:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : listVolumePrice
Type:
object
list volume price of the product
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
Type:
object
Sale 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:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
List 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:
object
List 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:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : items
Type:
Show Source
object
-
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:
object
Seo 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:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : priceGroupId1
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
Type:
object
List price of the product in price group 1
Show Source
-
pricingScheme(optional):
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : pricingScheme
Type:
object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(optional):
array levels
Price levels array for volume price
-
numLevels(optional):
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
minimum quantity for price level
-
levelMinimum(optional):
number
minimum quantity for price level
-
price(optional):
number
price value for price level
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Order of listing in product inventory.
-
property(optional):
string
Display name as a product property.
Example Response (application/json)
{
"total":92,
"totalResults":92,
"totalExpandedResults":92,
"limit":250,
"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=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=100&width=100",
"largeImage":null,
"smallImage":null,
"nonreturnable":false,
"displayName":"16 Candles",
"orderLimit":null,
"description":"A really great movie that you should not miss.",
"onlineOnly":true,
"primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg",
"listPrices":null,
"salePrices":null,
"productVariantOptions":[
{
"listingVariant":false,
"optionValueMap":{
"Silver":1,
"Neon":2,
"Black":0
},
"variantBasedDisplay":false,
"optionId":"color",
"mapKeyPropertyAttribute":"sku-camcorder_color",
"optionName":"color"
}
],
"largeImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=940&width=940"
],
"primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=940&width=940",
"addOnProducts":[
{
"repositoryId":"cp10003",
"addOnOptions":[
{
"product":{
"displayName":"Birthday Gift Wrap",
"repositoryId":"BirthdayGiftWrap",
"active":true
},
"repositoryId":"co10005",
"sku":{
"displayName":"option1",
"repositoryId":"option1",
"active":true
}
},
{
"product":{
"displayName":"Birthday Gift Wrap",
"repositoryId":"BirthdayGiftWrap",
"active":true
},
"repositoryId":"co10006",
"sku":{
"displayName":"option2",
"repositoryId":"option2",
"active":true
}
}
]
}
],
"derivedShippingSurchargeFrom":"defaultPriceGroup",
"smallImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300"
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"id":"Product_19Cxy",
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"largeImage":null,
"smallImage":null,
"nonreturnable":false,
"listPrices":null,
"salePrices":null,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"derivedOnlineOnly":true,
"smallImageURLs":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"thumbnailImage":null,
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"salePrice":4.99,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Sku_19Dxy",
"DynamicSkuProperty2":"value2",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"DynamicSkuProperty1":"value1",
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":12.99
},
{
"dynamicPropertyMapLong":{
},
"salePriceStartDate":null,
"largeImage":null,
"smallImage":null,
"salePrice":null,
"nonreturnable":false,
"active":true,
"listPrices":null,
"salePrices":null,
"configurationMetadata":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"derivedListPriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"repositoryId":"Sku_19Dxyi",
"shippingSurcharge":10,
"thumbnailImage":null,
"salePriceEndDate":null,
"listPrice":null
},
{
"dynamicPropertyMapLong":{
},
"salePriceStartDate":null,
"largeImage":null,
"smallImage":null,
"salePrice":8.99,
"nonreturnable":false,
"active":true,
"listPrices":null,
"salePrices":null,
"configurationMetadata":[
],
"derivedSalePriceFrom":"defaultPriceGroup",
"derivedListPriceFrom":"defaultPriceGroup",
"shippingSurcharges":null,
"repositoryId":"Sku_19Dxyii",
"shippingSurcharge":null,
"thumbnailImage":null,
"salePriceEndDate":null,
"listPrice":19.99
}
],
"salePrice":8.99,
"primaryMediumImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=475&width=475",
"fullImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg"
],
"active":true,
"thumbImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=100&width=100"
],
"creationDate":"2014-10-27T05:11:57.034Z",
"variantValuesOrder":{
"color":[
"Spring Green",
"Cranberry",
"Marigold"
],
"size":[
"Small",
"Large",
"Medium"
]
},
"route":"/16-candles/product/Product_19Cxy",
"mediumImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=475&width=475"
],
"derivedListPriceFrom":"defaultPriceGroup",
"repositoryId":"Product_19Cxy",
"primarySourceImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300",
"shippingSurcharge":20,
"primarySmallImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300",
"sourceImageURLs":[
"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300"
],
"avgCustRating":4.5,
"listPrice":19.99
}
]
}
Default Response
The error response
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