listProducts
get
/ccadmin/v1/products
List Products. Gets a list of products. Optionally search for products in the given catalog and collection by performing a case-insensitive, partial-match on the display name or ID. Optionally takes the x-ccasset-language header to get translated content in another language.
To get the list of included/excluded Products in a promotion, use a group of {promotionId, itemTypeList and templateValue} parameters together.
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
ID of a catalog to filter products.
-
categoryId(optional): string
Filter the response to just products in the given category id.
-
continueOnMissingProduct(optional): boolean
boolean flag to determine whether to continue if a product is missing.
-
depth(optional): string
Depth of nested response from 0 to 6. Defaults to 4. NOTE: Caution should be used as increasing depth can negatively affect performance.
-
expand(optional): boolean
Boolean indicating if the expanded product information should be returned.
-
fields(optional): string
Comma-separated list of product properties to further limit the properties returned so as to reduce response size. When used in combination with other query parameters, the response may not return all the requested properties. When used with the expand query parameter set to true, the response returns all product properties.
-
frontLoadPrices(optional): boolean
If price maps need to be computed for a large number of price lists then setting this to true may improve performance. Defaults to false.
-
includeBaseCatalogProducts(optional): boolean
Boolean flag if true then isFilteredCatalogMember field will be added for each product in the response. Defaults to false.
-
includePrices(optional): boolean
Boolean flag to determine whether to include price maps for the products in the response. Default is true.
-
itemTypeList(optional): string
Type of products list associated with the given promotion id -includedProducts or excludedProducts
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
minimalList(optional): boolean
Returns a minimal set of properties. Adds two properties, onSale and priceRange, so that those two values do not need to be computed by the client. This can be combined with any other query parameters that do not depend on properties not returned. This cannot be combined with 'expand' as they are mutually exclusive.
-
name(optional): string
Partial displayName of a product to use for search.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
orphaned(optional): string
Filter response to products with no parent categories.
-
pageResults(optional): boolean
Return response with paginated pattern, to be used with query params - name/productIds/promotion group {promotionId, itemTypeList, templateValue}
-
priceListGroupId(optional): string
Price list group id for adding the prices to the product in the response.
-
productIds(optional): string
Product IDs to list.
-
promotionId(optional): string
The promotion id for the included/excluded products list. If promotionId is included then include the itemTypeList and templateValue parameters to get the include/exclude product list for the promotion
-
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: * avgCustRating * brand * childSKUs * description * displayName * id * largeImage * longDescription * notForIndividualSale * orderLimit * productImages * smallImage Additionally, custom product properties may also be used in a q query.
-
showAccessControlInfo(optional): boolean
Boolean flag to determine whether to show currently logged in user's access control information for the products in the response. Default value is false.
-
showInactiveProducts(optional): boolean
Boolean flag to determine whether to include inactive products as part of the result.
-
showQuantity(optional): string
Show inventory quantity.
-
showTranslations(optional): boolean
Boolean indicating if the translations property should be returned for each item in the response.
-
templateValue(optional): string
UI Template value associated with the included/excluded products list - e.g PSC_Value, optional_offer_psc_value etc
-
unassigned(optional): string
Filter response to products in the given catalog's default category for products.
-
useProductPriceForSku(optional): boolean
Option to use the inherited pricing from the product or SKU. This is true by default. When set to false, product prices are not considered for skus.
-
withPrices(optional): boolean
Boolean flag to determine whether prices will be returned or not; not returning prices will skip performing any price lookup for the products. Default is true. Setting this to false will supersede 'includePrices'.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
-
X-CCProfileType(optional): string
Profile type 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":3,
"totalResults":3,
"offset":0,
"limit":3,
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"discountable":true,
"items":[
{
"longDescription":"Stunning lines and unusual details\n\t\t\tgive the Aruba dining chair its sophisticated visual appeal. Made of\n\t\t\tbeech. The padded seat is top-quality leather, and the backrest\n\t\t\tfeatures brass accents.",
"primaryThumbImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=150&width=150",
"largeImage":{
"repositoryId":"m3057",
"url":"/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg"
},
"smallImage":{
"repositoryId":"m3056",
"url":"/cloudlakeimages/crsdocroot/content/images/products/small/ST_ArubaDiningChair_small.jpg"
},
"listVolumePrice":null,
"displayName":"Aruba Dining Chair",
"orderLimit":null,
"description":"Modern elegance in this leather and\n\t\t\twood chair",
"listPrices":{
"UsDollar":169,
"CaDollar":170
},
"primaryFullImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg",
"salePrices":{
"UsDollar":null,
"CaDollar":null
},
"largeImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=940&width=940"
],
"listVolumePrices":{
},
"primaryLargeImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=940&width=940",
"smallImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"UsDollar",
"derivedSalePriceFrom":"UsDollar",
"shippingSurcharges":{
"UsDollar":null,
"CaDollar":null
},
"id":"xprod2166",
"saleVolumePrices":{
"UsDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
},
"CaDollar":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
}
},
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
{
"repositoryId":"skul40005"
}
],
"largeImage":null,
"smallImage":null,
"listVolumePrice":null,
"nonreturnable":false,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"listVolumePrices":"{}",
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"thumbnailImage":null,
"saleVolumePrices":"{}",
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":50,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"soldAsPackage":false,
"mediumImageURLs":[
],
"repositoryId":"xsku2166",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":169
}
],
"saleVolumePrice":{
"bulkPrice":{
"numLevels":3,
"levels":[
{
"price":19,
"levelMinimum":1,
"levelMaximum":5
},
{
"price":12.35,
"levelMinimum":21,
"levelMaximum":30
},
{
"price":10.25,
"levelMinimum":31
}
]
}
},
"primaryMediumImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=640&width=640",
"salePrice":null,
"fullImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg"
],
"thumbImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=150&width=150"
],
"creationDate":"2017-01-09T05:09:29.000Z",
"productImages":[
],
"route":"/aruba-dining-chair/product/xprod2166",
"mediumImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=640&width=640"
],
"repositoryId":"xprod2166",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":"http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg",
"shippingSurcharge":null,
"primarySmallImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg&height=300&width=300",
"sourceImageURLs":[
"http://localhost:9080/cloudlakeimages/crsdocroot/content/images/products/full/ST_ArubaDiningChair_full.jpg"
],
"avgCustRating":null,
"listPrice":169
},
{
"longDescription":null,
"primaryThumbImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=150&width=150",
"largeImage":{
"repositoryId":"imgaspensnow",
"url":"/cloudlakeimages/imgaspensnow.jpg"
},
"smallImage":null,
"displayName":"Aspen Snow Blanket",
"orderLimit":null,
"description":"Perfect blanket for a snowy night.",
"listPrices":{
"UsDollar":77.99,
"CaDollar":87.99
},
"primaryFullImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg",
"salePrices":{
"UsDollar":null,
"CaDollar":null
},
"largeImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=940&width=940"
],
"primaryLargeImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=940&width=940",
"smallImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"UsDollar",
"derivedSalePriceFrom":"UsDollar",
"shippingSurcharges":{
"UsDollar":null,
"CaDollar":null
},
"id":"prodaspensnow",
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":{
"repositoryId":"imgaspensnow",
"url":"/cloudlakeimages/imgaspensnow.jpg"
},
"smallImage":{
"repositoryId":"imgaspensnowSmall",
"url":"/cloudlakeimages/imgaspensnow-sm.jpg"
},
"nonreturnable":false,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"thumbnailImage":{
"repositoryId":"imgaspensnowThumb",
"url":"/cloudlakeimages/imgaspensnow-tn.jpg"
},
"salePriceEndDate":null,
"salePriceStartDate":null,
"images":[
],
"quantity":25,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"skuaspensnow",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null
}
],
"primaryMediumImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=640&width=640",
"salePrice":null,
"fullImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg"
],
"thumbImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=150&width=150"
],
"creationDate":"2017-01-09T05:09:29.000Z",
"productImages":[
],
"route":"/aspen-snow-blanket/product/prodaspensnow",
"mediumImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=640&width=640"
],
"repositoryId":"prodaspensnow",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":"http://localhost:9080/cloudlakeimages/imgaspensnow.jpg",
"shippingSurcharge":null,
"primarySmallImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgaspensnow.jpg&height=300&width=300",
"sourceImageURLs":[
"http://localhost:9080/cloudlakeimages/imgaspensnow.jpg"
],
"avgCustRating":4.5,
"listPrice":77.99
},
{
"longDescription":null,
"primaryThumbImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=150&width=150",
"largeImage":{
"repositoryId":"imgatlanticnightsky",
"url":"/cloudlakeimages/imgatlanticnightsky.jpg"
},
"smallImage":null,
"listVolumePrice":null,
"displayName":"Atlantic Nightsky Blanket",
"orderLimit":null,
"description":"Cozy and soft blanket.",
"listPrices":{
"UsDollar":77.99,
"CaDollar":87.99
},
"primaryFullImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg",
"salePrices":{
"UsDollar":null,
"CaDollar":null
},
"largeImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=940&width=940"
],
"listVolumePrices":{
},
"primaryLargeImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=940&width=940",
"smallImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=300&width=300"
],
"derivedShippingSurchargeFrom":"UsDollar",
"derivedSalePriceFrom":"UsDollar",
"shippingSurcharges":{
"UsDollar":null,
"CaDollar":null
},
"id":"prodatlanticnightsky",
"saleVolumePrices":{
},
"childSKUs":[
{
"dynamicPropertyMapLong":{
},
"primaryThumbImageURL":null,
"bundleLinks":[
],
"largeImage":{
"repositoryId":"imgatlanticnightsky",
"url":"/cloudlakeimages/imgatlanticnightsky.jpg"
},
"smallImage":{
"repositoryId":"imgatlanticnightskySmall",
"url":"/cloudlakeimages/imgatlanticnightsky-sm.jpg"
},
"listVolumePrice":null,
"nonreturnable":false,
"primaryFullImageURL":null,
"configurationMetadata":[
],
"productListingSku":null,
"largeImageURLs":[
],
"primaryLargeImageURL":null,
"smallImageURLs":[
],
"derivedSalePriceFrom":"UsDollar",
"thumbnailImage":{
"repositoryId":"imgatlanticnightskyThumb",
"url":"/cloudlakeimages/imgatlanticnightsky-tn.jpg"
},
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":21,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"skuatlanticnightsky",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"primarySourceImageURL":null,
"primarySmallImageURL":null,
"sourceImageURLs":[
],
"listPrice":null
}
],
"saleVolumePrice":null,
"primaryMediumImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=640&width=640",
"salePrice":null,
"fullImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg"
],
"thumbImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=150&width=150"
],
"creationDate":"2017-01-09T05:09:29.000Z",
"productImages":[
],
"route":"/atlantic-nightsky-blanket/product/prodatlanticnightsky",
"mediumImageURLs":[
"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=640&width=640"
],
"repositoryId":"prodatlanticnightsky",
"derivedListPriceFrom":"UsDollar",
"primarySourceImageURL":"http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg",
"shippingSurcharge":null,
"primarySmallImageURL":"http://localhost:9080/ccstore/v1/images/?source=http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg&height=300&width=300",
"sourceImageURLs":[
"http://localhost:9080/cloudlakeimages/imgatlanticnightsky.jpg"
],
"avgCustRating":4,
"listPrice":77.99
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle CX Commerce:
|Error Code|Description|
|------------------|------------------|
|21169|invalid template value incorrect_value.|
|21168|templateValue is a required property for this request|
|20034|Get ProductList Internal Error|
|21167|itemTypeList is a required property for this request|
|21001|Promotion not found for the given id: invalidId|
|21166|itemTypeList can either be includedProducts or excludedProducts for this request|
|25013|price List InternalError|
|20041|Null ProductListingRequest argument passed to method|
|20040|Get Product Type Internal Error|
|10002|Invalid value [ {1} ] for parameter: {0}.|
|21170|promotionId is a required property for this request|
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