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):
object items
Images and urls of the product. Image Urls are not encoded.
-
limit(optional):
integer
the total number of products that can be returned
-
sort(optional):
object sort
Sorting criteria of the products.
-
total(optional):
integer
The total number of products returned. Deprecated.
-
totalExpandedResults(optional):
integer
The total number of expanded products is returned only if value for category Id is set in the request.
-
totalResults(optional):
integer
The total number of products returned.
Nested Schema : items
Type:
object
Images and urls of the product. Image Urls are not encoded.
Show Source
-
active(optional):
boolean
The active property of the product
-
addOnProducts(optional):
array addOnProducts
List of add-on products associated with the product
-
avgCustRating(optional):
string
the average customer rating of the product
-
childSKUs(optional):
array childSKUs
List of SKU's for the product.
-
creationDate(optional):
string
product creation date
-
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
The product description
-
displayName(optional):
string
The display name of the product
-
fullImageURLs(optional):
array fullImageURLs
The array of full image URLs. Urls are not encoded.
-
id(optional):
string
The product ID
-
largeImage(optional):
string
the large image of the product. Url is not encoded.
-
largeImageURLs(optional):
array largeImageURLs
The array of large image URLs. Urls are not encoded.
-
listPrice(optional):
number
The list price
-
listPrices(optional):
object listPrices
list prices of the SKU in respective price list groups
-
longDescription(optional):
string
The long description of the product
-
mediumImageURLs(optional):
array mediumImageURLs
The url of the medium image. Url is not encoded.
-
nonreturnable(optional):
boolean
Indicates whether the product is returnable or not.
-
notForIndividualSale(optional):
boolean
States whether not a product may be sold individually rather than, for example, as part of a configured product
-
onlineOnly(optional):
boolean
online only property
-
orderLimit(optional):
string
the order limit of the product
-
primaryFullImageURL(optional):
string
The url of the primary full image. Url is not encoded.
-
primaryLargeImageURLs(optional):
string
The url of the primary large image. Url is not encoded.
-
primaryMediumImageURL(optional):
string
The primary medium image URL of the product. Url is not encoded.
-
primarySmallImageURL(optional):
string
The primary small image URL of the product. Url is not encoded.
-
primarySourceImageURL(optional):
string
the primary source image of the url.Url is not encoded.
-
primaryThumbImageURL(optional):
string
the primary source image of the url. Url is not encoded.
-
productVariantOptions(optional):
array productVariantOptions
Objects containing product's variant options details if available for the product.
-
repositoryId(optional):
string
The repository ID of the product
-
route(optional):
string
The route property of the product
-
salePrice(optional):
number
The sale price of the product
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
secondaryCurrencyShippingSurcharge(optional):
number
Extra handling cost for shipping the product in monetary currency. In case of mix currency, if payShippingInSecondaryCurrency flag is set to true and the secondaryCurrencyCode is set at site, this amount will be calculated according to the exchange rate defined between selected priceListGroup's currency code and site's secondary currency code
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage(optional):
array smallImage
The array of small image URLs. Urls are not encoded.
-
smallImageURLs(optional):
array smallImageURLs
The urls of the small image.Urls are not encoded.
-
sourceImageURLs(optional):
array sourceImageURLs
The array of source image URLs. Urls are not encoded.
-
thumbImageURLs(optional):
array thumbImageURLs
The array of thumbnail image URLs. Urls are not encoded.
-
variantValuesOrder(optional):
object variantValuesOrder
Object having various variant property as key and ordered values array as the value.
Nested Schema : sort
Type:
object
Sorting criteria of the products.
Show Source
-
order(optional):
string
The order in which the products should be listed(asc/desc).
-
property(optional):
string
The property on which to do the ordering of products.
Nested Schema : addOnProducts
Type:
array
List of add-on products associated with the product
Show Source
Nested Schema : fullImageURLs
Type:
array
The array of full image URLs. Urls are not encoded.
Show Source
Nested Schema : largeImageURLs
Type:
array
The array of large image URLs. Urls are not encoded.
Show Source
Nested Schema : listPrices
Type:
object
list prices of the SKU in respective price list groups
Show Source
-
plg1(optional):
number
list price in plg1
-
plg2(optional):
number
list price in plg2
Nested Schema : mediumImageURLs
Type:
array
The url of the medium image. Url is not encoded.
Show Source
Nested Schema : productVariantOptions
Type:
array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type:
object
sale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : smallImage
Type:
array
The array of small image URLs. Urls are not encoded.
Show Source
Nested Schema : smallImageURLs
Type:
array
The urls of the small image.Urls are not encoded.
Show Source
Nested Schema : sourceImageURLs
Type:
array
The array of source image URLs. Urls are not encoded.
Show Source
Nested Schema : thumbImageURLs
Type:
array
The array of thumbnail image URLs. Urls are not encoded.
Show Source
Nested Schema : variantValuesOrder
Type:
object
Object having various variant property as key and ordered values array as the value.
Show Source
Nested Schema : items
Type:
Show Source
object
-
addOnOptions(optional):
array addOnOptions
List of options within a configurable Property
-
repositoryId(optional):
string
The repository Id of the configurable property
Nested Schema : items
Type:
Show Source
object
-
product(optional):
object product
The add-on product associated with product
-
repositoryId(optional):
string
The repository Id of the add-on option
-
sku(optional):
object sku
The add-on sku associated with product
Nested Schema : product
Type:
object
The add-on product associated with product
Show Source
-
active(optional):
boolean
Flag indicating if the product is active
-
displayName(optional):
string
Display Name of the product
-
repositoryId(optional):
string
The repository Id of the product
Nested Schema : sku
Type:
object
The add-on sku associated with product
Show Source
-
active(optional):
boolean
Flag indicating if the sku is active
-
displayName(optional):
string
Display Name of the sku
-
repositoryId(optional):
string
The repository Id of the sku
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
SKU active property
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedListPriceFrom(optional):
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedOnlineOnly(optional):
boolean
Indicates if the SKU is avilable online or not.
-
derivedSalePriceFrom(optional):
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
dynamicPropertyMapLong(optional):
string
The dynamic mapping of the product
-
DynamicSKUProperty(optional):
string
Dynamic Properties of SKU.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
largeImage(optional):
string
The large image of the product
-
largeImageURLs(optional):
array largeImageURLs
Large Image URLs of SKU.
-
listingSKUId(optional):
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(optional):
number
The list price of the product
-
listPrices(optional):
object listPrices
list prices of the product in respective price list groups
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Indicates whether the SKU is returnable or not.
-
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.
-
repositoryId(optional):
string
The repository Id of the product
-
salePrice(optional):
number
The sale price of the product
-
salePriceEndDate(optional):
string
The date from which the sale for this product is not valid
-
salePrices(optional):
object salePrices
sale prices of the product in respective price list groups
-
salePriceStartDate(optional):
string
The date from which sale price of the product is valid
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
-
shippingSurcharges(optional):
object shippingSurcharges
Extra handling costs for shipping the product in respective price list groups
-
smallImage(optional):
string
The small image of the product
-
smallImageURLs(optional):
array smallImageURLs
Small Image URLs of SKU.
-
sourceImageURLs(optional):
array sourceImageURLs
Source Image URLs of SKU.
-
thumbImageURLs(optional):
array thumbImageURLs
Thumb Image URLs of SKU.
-
thumbnailImage(optional):
string
The thumbanil image of the product
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : listPrices
Type:
object
list prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
list price of the product in plg1
-
plg2(optional):
number
list price of the product in plg2
Nested Schema : salePrices
Type:
object
sale prices of the product in respective price list groups
Show Source
-
plg1(optional):
number
sale price of the product in plg1
-
plg2(optional):
number
sale price of the product in plg2
Nested Schema : shippingSurcharges
Type:
object
Extra handling costs for shipping the product in respective price list groups
Show Source
-
plg1(optional):
number
Extra handling costs for shipping the product in plg1
-
plg2(optional):
number
Extra handling costs for shipping the product in plg2
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the configuration attribute.
-
repositoryId(optional):
string
The repository id for existing configuration metadata items.
-
value(optional):
string
The value of the configuration attribute.
Nested Schema : items
Type:
Show Source
object
-
listingVariant(optional):
boolean
Whether listing should be done based on this variant.
-
mapKeyPropertyAttribute(optional):
string
map key property
-
optionId(optional):
string
option Id
-
optionName(optional):
string
option Name
-
optionValueMap(optional):
object optionValueMap
Additional Properties Allowed: additionalPropertiesmapping of all option values with corresponding option value ids
-
variantBasedDisplay(optional):
boolean
Whether this variant based display should be allowed.
Nested Schema : optionValueMap
Type:
object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
-
optionValue(optional):
string
Option Value
-
optionValueId(optional):
integer
Option Value Id
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