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.
-
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.
-
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.
-
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
Array of AddOn products.
-
avgCustRating(optional):
string
Average customer rating of the product.
-
childSKUs(optional):
array childSKUs
Array having various properties of child SKU.
-
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.
-
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.
-
listPrices(optional):
object listPrices
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.
-
nonreturnable(optional):
boolean
Tells whether the product is returnable or not
-
onlineOnly(optional):
boolean
Tells whether the product is online.
-
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.
-
productNumber(optional):
string
Product number of the product.
-
productVariantOptions(optional):
array productVariantOptions
Objects containing product's variant options details if available for the product.
-
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.
-
salePrices(optional):
object salePrices
Object with price group IDs as keys and sale prices as values.
-
secondaryCurrencyShippingSurcharge(optional):
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(optional):
number
Extra handling cost while shipping the product, in the default price group.
-
shippingSurcharges(optional):
object shippingSurcharges
Object with price group IDs as keys and shipping surcharges as values.
-
smallImage(optional):
object smallImage
Array having repository ID and URL of small image of the SKU.
-
smallImageURLs(optional):
string
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 : addOnProducts
Type:
array
Array of AddOn products.
Show Source
-
Array of:
object items
AddOn 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 : listPrices
Type:
object
Object with price group IDs as keys and list prices as values.
Show Source
-
Price Group ID 1(optional):
number
List price of product in price group 1.
-
Price Group ID 2(optional):
number
List price of product in price group 2.
Nested Schema : productVariantOptions
Type:
array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type:
object
Object with price group IDs as keys and sale prices as values.
Show Source
-
Price Group ID 1(optional):
number
Sale price of product in price group 1.
-
Price Group ID 2(optional):
number
Sale price of product in price group 2.
Nested Schema : shippingSurcharges
Type:
object
Object with price group IDs as keys and shipping surcharges as values.
Show Source
-
Price Group ID 1(optional):
number
Shipping surcharge of product in price group 1.
-
Price Group ID 2(optional):
number
Shipping surcharge of product in price group 2.
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:
object
AddOn product.
Show Source
-
configurationOptions(optional):
array configurationOptions
Array of configuration options.
-
id(optional):
string
Repository ID
-
repositoryId(optional):
string
Repository ID of configurable product.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Repository ID
-
product(optional):
object product
Product Details
-
repositoryId(optional):
string
Repository ID of configuration option.
-
sku(optional):
object sku
Sku Details
Nested Schema : product
Type:
object
Product Details
Show Source
-
displayName(optional):
string
Display name of product.
-
id(optional):
string
Repository ID
-
repositoryId(optional):
string
Repository ID of product.
-
type(optional):
string
Type of product.
Nested Schema : sku
Type:
object
Sku Details
Show Source
-
id(optional):
string
Repository ID
-
repositoryId(optional):
string
Repository ID of sku.
Nested Schema : items
Type:
Show Source
object
-
configurationMetadata(optional):
array configurationMetadata
Array of configuration attributes associated with the SKU.
-
derivedOnlineOnly(optional):
boolean
Indicates if the SKU is available online or not.
-
dynamicPropertyMapLong(optional):
integer
Dynamic property map long of the SKU.
-
DynamicSKUProperty(optional):
string
Dynamic Properties of SKU.
-
fullImageURLs(optional):
array fullImageURLs
Full Image URLs of SKU.
-
id(optional):
string
SKU id
-
largeImage(optional):
integer
Large image of the SKU.
-
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):
integer
List price of the SKU.
-
mediumImageURLs(optional):
array mediumImageURLs
Medium Image URLs SKU.
-
nonreturnable(optional):
boolean
Tells 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.
-
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.
-
shippingSurcharge(optional):
integer
Extra handling costs while shipping the product.
-
smallImage(optional):
integer
Small image of the SKU.
-
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
Thumbnail image of the SKU.
Nested Schema : configurationMetadata
Type:
array
Array of configuration attributes associated with the SKU.
Show Source
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
-
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 : 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
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"
],
"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":[
],
"thumbnailImage":null,
"saleVolumePrices":"{}",
"salePriceEndDate":null,
"saleVolumePrice":null,
"salePriceStartDate":null,
"images":[
],
"quantity":50,
"salePrice":null,
"primaryMediumImageURL":null,
"fullImageURLs":[
],
"active":true,
"thumbImageURLs":[
],
"mediumImageURLs":[
],
"repositoryId":"xsku2166",
"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",
"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"
],
"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":[
],
"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",
"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",
"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"
],
"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":[
],
"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",
"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",
"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 Commerce Cloud:
|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