1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Products

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
Type: string
the catalog ID for the site
categoryId
Type: string
the category ID
includeChildSKUsListingIds
Type: boolean
If this flag is true then listingVariant repository id will be included in each of the childSKU of style based product
includeChildren
Type: boolean
flag to include children of categories or not
limit
Type: integer
The number of items per block
offset
Type: integer
startingIndex the index of the first record to load
productIds
Type: string
the list of product IDs
q
Type: 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 * 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
Type: string
Sort Option id: Sort order
storePriceListGroupId
Type: string
the price list group id for which product prices are to be returned
totalExpandedResults
Type: boolean
flag to include count of total products with listing variant expansion
totalResults
Type: boolean
flag to include count of total products without expansion
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listProducts_response
Nested Schema : items
Type: object
Images and urls of the product. Image Urls are not encoded.
Nested Schema : sort
Type: object
Sorting criteria of the products.
Nested Schema : childSKUs
Type: array
List of SKU's for the product.
Nested Schema : fullImageURLs
Type: array
The array of full image URLs. Urls are not encoded.
Nested Schema : largeImageURLs
Type: array
The array of large image URLs. Urls are not encoded.
Nested Schema : listPrices
Type: object
list prices of the SKU in respective price list groups
Nested Schema : mediumImageURLs
Type: array
The url of the medium image. Url is not encoded.
Nested Schema : productVariantOptions
Type: array
Objects containing product's variant options details if available for the product.
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImage
Type: array
The array of small image URLs. Urls are not encoded.
Nested Schema : smallImageURLs
Type: array
The urls of the small image.Urls are not encoded.
Nested Schema : sourceImageURLs
Type: array
The array of source image URLs. Urls are not encoded.
Nested Schema : thumbImageURLs
Type: array
The array of thumbnail image URLs. Urls are not encoded.
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Nested Schema : items
Type: object
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : listPrices
Type: object
list prices of the product in respective price list groups
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Nested Schema : items
Type: object
Nested Schema : optionValueMap
Type: object
mapping of all option values with corresponding option value ids
Example 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.",
            "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg",
            "listPrices":null,
            "salePrices":null,
            "productVariantOptions":[
                {
                    "optionValueMap":{
                        "Silver":1,
                        "Neon":2,
                        "Black":0
                    },
                    "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",
            "smallImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300"
            ],
            "shippingSurcharges":null,
            "id":"Product_19Cxy",
            "childSKUs":[
                {
                    "dynamicPropertyMapLong":{
                    },
                    "primaryThumbImageURL":null,
                    "largeImage":null,
                    "smallImage":null,
                    "nonreturnable":false,
                    "listPrices":null,
                    "salePrices":null,
                    "primaryFullImageURL":null,
                    "productListingSku":null,
                    "largeImageURLs":[
                    ],
                    "primaryLargeImageURL":null,
                    "smallImageURLs":[
                    ],
                    "shippingSurcharges":null,
                    "thumbnailImage":null,
                    "salePriceEndDate":null,
                    "salePriceStartDate":null,
                    "images":[
                    ],
                    "salePrice":4.99,
                    "primaryMediumImageURL":null,
                    "fullImageURLs":[
                    ],
                    "active":true,
                    "thumbImageURLs":[
                    ],
                    "mediumImageURLs":[
                    ],
                    "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,
                    "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,
                    "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"
            ],
            "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
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "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.",
    "primaryFullImageURL": "/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg",
    "listPrices": null,
    "salePrices": null,
    "productVariantOptions": [{
      "optionValueMap": {
        "Silver": 1,
        "Neon": 2,
        "Black": 0
      },
      "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",
    "smallImageURLs": ["/ccstore/v1/images/?source=http://localhost:8080/file/qaimg/products/sixteen_candles_LARGE.jpg&height=300&width=300"],
    "shippingSurcharges": null,
    "id": "Product_19Cxy",
    "childSKUs": [
      {
        "dynamicPropertyMapLong": {},
        "primaryThumbImageURL": null,
        "largeImage": null,
        "smallImage": null,
        "nonreturnable": false,
        "listPrices": null,
        "salePrices": null,
        "primaryFullImageURL": null,
        "productListingSku": null,
        "largeImageURLs": [],
        "primaryLargeImageURL": null,
        "smallImageURLs": [],
        "shippingSurcharges": null,
        "thumbnailImage": null,
        "salePriceEndDate": null,
        "salePriceStartDate": null,
        "images": [],
        "salePrice": 4.99,
        "primaryMediumImageURL": null,
        "fullImageURLs": [],
        "active": true,
        "thumbImageURLs": [],
        "mediumImageURLs": [],
        "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,
        "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,
        "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"],
    "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
  }]
}