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
Query Parameters
  • ID of a catalog to filter products.
  • Filter the response to just products in the given category id.
  • boolean flag to determine whether to continue if a product is missing.
  • Depth of nested response from 0 to 6. Defaults to 4. NOTE: Caution should be used as increasing depth can negatively affect performance.
  • Boolean indicating if the expanded product information should be returned.
  • Boolean flag to determine whether to include price maps for the products in the response. Default is true.
  • Type of products list associated with the given promotion id -includedProducts or excludedProducts
  • This is the field to determine number of records to be fetched per REST call.
  • 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.
  • Partial displayName of a product to use for search.
  • This field determines the offset/starting index from which data to be fetched.
  • Filter response to products with no parent categories.
  • Return response with paginated pattern, to be used with query params - name/productIds/promotion group {promotionId, itemTypeList, templateValue}
  • Price list group id for adding the prices to the product in the response.
  • Product IDs to list.
  • 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
  • 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.
  • Boolean flag to determine whether to include inactive products as part of the result.
  • Show inventory quantity.
  • Boolean indicating if the translations property should be returned for each item in the response.
  • UI Template value associated with the included/excluded products list - e.g PSC_Value, optional_offer_psc_value etc
  • Filter response to products in the given catalog's default category for products.
  • 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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listProducts_response
Type: object
Show Source
Nested Schema : items
Type: array
Array having various products.
Show Source
Nested Schema : sort
Type: array
Array having the order and property of product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : addOnProducts
Type: array
Array of AddOn products.
Show Source
Nested Schema : childSKUs
Type: array
Array having various properties of child SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
Full image URLs of the product.
Show Source
Nested Schema : largeImage
Type: object
Array having repository ID and URL of the large image of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large image URLs of the product.
Show Source
Nested Schema : listPrices
Type: object
Object with price group IDs as keys and list prices as values.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium image URLs of the product.
Show Source
Nested Schema : productImages
Type: array
Array of product images.
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
Object with price group IDs as keys and sale prices as values.
Show Source
Nested Schema : shippingSurcharges
Type: object
Object with price group IDs as keys and shipping surcharges as values.
Show Source
Nested Schema : smallImage
Type: object
Array having repository ID and URL of small image of the SKU.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source image URLs of the product.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb image URLs of the product.
Show Source
Nested Schema : items
Type: object
AddOn product.
Show Source
Nested Schema : configurationOptions
Type: array
Array of configuration options.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : product
Type: object
Product Details
Show Source
Nested Schema : sku
Type: object
Sku Details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : configurationMetadata
Type: array
Array of configuration attributes associated with the SKU.
Show Source
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Show Source
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Show Source
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Show Source
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : metadata
Type: object
Seo meta info for product.
Show Source
Nested Schema : tags
Type: array
The array of product image tags
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : optionValueMap
Type: object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
Nested Schema : items
Type: object
Show Source
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|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top