1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Store
  4. Products

listProductsForLargeCart

post

/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
Query Parameters
Header Parameters
Body ()
Root Schema : listProductsForLargeCart_request
Type: object
Show Source
Example:
{
    "productIds":"Product_27Fxyzi,Product_21Cxi",
    "storePriceListGroupId":"defaultPriceGroup"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listProductsForLargeCart_response
Type: object
Show Source
Nested Schema : items
Type: object
Images and urls of the product. Image Urls are not encoded.
Show Source
Nested Schema : sort
Type: object
Sorting criteria of the products.
Show Source
Nested Schema : addOnProducts
Type: array
List of add-on products associated with the product
Show Source
Nested Schema : childSKUs
Type: array
List of SKU's for the product.
Show Source
Nested Schema : fullImageURLs
Type: array
The array of full image URLs. Urls are not encoded.
Show Source
Nested Schema : largeImageURLs
Type: array
The array of large image URLs. Urls are not encoded.
Show Source
Nested Schema : listPrices
Type: object
list prices of the SKU in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
The url of the medium image. Url is not encoded.
Show Source
Nested Schema : productVariantOptions
Type: array
Objects containing product's variant options details if available for the product.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
Show Source
Nested Schema : smallImage
Type: array
The array of small image URLs. Urls are not encoded.
Show Source
Nested Schema : smallImageURLs
Type: array
The urls of the small image.Urls are not encoded.
Show Source
Nested Schema : sourceImageURLs
Type: array
The array of source image URLs. Urls are not encoded.
Show Source
Nested Schema : thumbImageURLs
Type: array
The array of thumbnail image URLs. Urls are not encoded.
Show Source
Nested Schema : variantValuesOrder
Type: object
Object having various variant property as key and ordered values array as the value.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : addOnOptions
Type: array
List of options within a configurable Property
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : product
Type: object
The add-on product associated with product
Show Source
Nested Schema : sku
Type: object
The add-on sku associated with product
Show Source
Nested Schema : items
Type: object
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 : listPrices
Type: object
list prices of the product in respective price list groups
Show Source
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Show Source
Nested Schema : salePrices
Type: object
sale prices of the product in respective price list groups
Show Source
Nested Schema : shippingSurcharges
Type: object
Extra handling costs for shipping the product in respective price list groups
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 : optionValueMap
Type: object
Additional Properties Allowed
Show Source
mapping of all option values with corresponding option value ids
Show Source
Example Response (application/json)
[
    {
        "listVolumePrice":null,
        "excludeFromSitemap":false,
        "relatedProducts":null,
        "orderLimit":null,
        "CountryOfOrigin":"US",
        "onlineOnly":false,
        "listPrices":null,
        "type":null,
        "largeImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940"
        ],
        "listVolumePrices":null,
        "shippable":true,
        "addOnProducts":[
        ],
        "derivedSalePriceFrom":"defaultPriceGroup",
        "primaryImageAltText":"Akira",
        "id":"Product_27Fxyzi",
        "brand":null,
        "parentCategories":[
            {
                "repositoryId":"Category_14Bxi",
                "fixedParentCategories":[
                    {
                        "repositoryId":"cat40014",
                        "fixedParentCategories":[
                            {
                                "repositoryId":"cat40013",
                                "fixedParentCategories":[
                                    {
                                        "repositoryId":"rootCategory"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "repositoryId":"cat70011",
                "fixedParentCategories":[
                    {
                        "repositoryId":"cat70001",
                        "fixedParentCategories":[
                            {
                                "repositoryId":"clearanceCat",
                                "fixedParentCategories":[
                                    {
                                        "repositoryId":"rootCategory"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "repositoryId":"topLeaf",
                "fixedParentCategories":[
                    {
                        "repositoryId":"rootCategory",
                        "fixedParentCategories":[
                        ]
                    },
                    {
                        "repositoryId":"dummyRootCategory",
                        "fixedParentCategories":[
                        ]
                    }
                ]
            },
            {
                "repositoryId":"AllProdPagination",
                "fixedParentCategories":[
                    {
                        "repositoryId":"rootCategory",
                        "fixedParentCategories":[
                        ]
                    }
                ]
            }
        ],
        "height":null,
        "defaultProductListingSku":null,
        "assetable":false,
        "unitOfMeasure":null,
        "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475",
        "seoUrlSlugDerived":"Akira",
        "weight":null,
        "active":true,
        "thumbImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100"
        ],
        "creationDate":"2010-11-17T13:42:37.000Z",
        "route":"/akira/product/Product_27Fxyzi",
        "relatedArticles":[
        ],
        "mediumImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=475&width=475"
        ],
        "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300",
        "parentCategory":null,
        "sourceImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300"
        ],
        "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300",
        "avgCustRating":4.5,
        "longDescription":"Akira isn???t just a movie ??? it???s the genesis of a genre. Katsuhiro\n                Otomo???s landmark cyberpunk classic obliterated the boundaries of Japanese animation and forced the world\n                to look into the future. Akira???s arrival shattered traditional thinking, creating space for movies like\n                the The Matrix to be dreamed into brutal reality. Without Kaneda and Tetsuo, without espers and psionic\n                assassins, without that badass motorcycle ??? our world would be a far less exciting place to exist. But\n                the manga became the movie and the movie became a phenomenon and the world took notice. Now, Akira is\n                everywhere. If you can???t see it in the streets ??? if you can???t feel it crawling around inside your brain\n                ??? then you have yet to be initiated. What. Are. You. Waiting. For?\n            ",
        "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=100&width=100",
        "nonreturnable":false,
        "displayName":"Akira",
        "description":"A really great movie that you should not miss.",
        "salePrices":null,
        "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg",
        "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=940&width=940",
        "smallImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg&height=300&width=300"
        ],
        "derivedShippingSurchargeFrom":"defaultPriceGroup",
        "shippingSurcharges":null,
        "saleVolumePrices":null,
        "primaryImageTitle":"Akira",
        "saleVolumePrice":null,
        "childSKUs":[
            {
                "productFamily":null,
                "dynamicPropertyMapLong":{
                },
                "primaryThumbImageURL":null,
                "bundleLinks":[
                ],
                "largeImage":null,
                "smallImage":null,
                "listVolumePrice":null,
                "nonreturnable":false,
                "displayName":null,
                "onlineOnly":false,
                "salePrices":null,
                "primaryFullImageURL":null,
                "listPrices":null,
                "productListingSku":null,
                "largeImageURLs":[
                ],
                "productLine":null,
                "listVolumePrices":null,
                "primaryLargeImageURL":null,
                "derivedOnlineOnly":false,
                "smallImageURLs":[
                ],
                "derivedSalePriceFrom":"defaultPriceGroup",
                "model":null,
                "thumbnailImage":null,
                "barcode":"200000000295",
                "saleVolumePrices":null,
                "salePriceEndDate":null,
                "saleVolumePrice":null,
                "salePriceStartDate":null,
                "images":[
                ],
                "quantity":null,
                "unitOfMeasure":null,
                "salePrice":null,
                "primaryMediumImageURL":null,
                "fullImageURLs":[
                ],
                "dynamicPropertyMapBigString":{
                },
                "active":true,
                "thumbImageURLs":[
                ],
                "mediumImageURLs":[
                ],
                "repositoryId":"Sku_27Gxyzi",
                "derivedListPriceFrom":"defaultPriceGroup",
                "primarySourceImageURL":null,
                "primarySmallImageURL":null,
                "sourceImageURLs":[
                ],
                "listPrice":24.99,
                "configurable":false
            }
        ],
        "relatedMediaContent":[
        ],
        "salePrice":null,
        "fullImageURLs":[
            "/ccstore/v1/images/?source=/file/v291840211342511571/products/akira_LARGE.jpg"
        ],
        "length":null,
        "variantValuesOrder":{
        },
        "notForIndividualSale":false,
        "repositoryId":"Product_27Fxyzi",
        "width":null,
        "derivedListPriceFrom":"defaultPriceGroup",
        "shippingSurcharge":null,
        "productImagesMetadata":[
            {
            }
        ],
        "configurable":false,
        "listPrice":24.99
    },
    {
        "listVolumePrice":null,
        "excludeFromSitemap":false,
        "relatedProducts":null,
        "orderLimit":null,
        "CountryOfOrigin":"US",
        "onlineOnly":false,
        "listPrices":null,
        "type":null,
        "largeImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=940&width=940"
        ],
        "listVolumePrices":null,
        "shippable":true,
        "addOnProducts":[
        ],
        "derivedSalePriceFrom":"defaultPriceGroup",
        "primaryImageAltText":"Dora the Explorer - Season 1",
        "id":"Product_21Cxi",
        "brand":null,
        "parentCategories":[
            {
                "repositoryId":"cat40007",
                "fixedParentCategories":[
                    {
                        "repositoryId":"cat40016",
                        "fixedParentCategories":[
                            {
                                "repositoryId":"cat40013",
                                "fixedParentCategories":[
                                    {
                                        "repositoryId":"rootCategory"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "repositoryId":"AllProdPagination",
                "fixedParentCategories":[
                    {
                        "repositoryId":"rootCategory",
                        "fixedParentCategories":[
                        ]
                    }
                ]
            }
        ],
        "height":null,
        "defaultProductListingSku":null,
        "assetable":false,
        "unitOfMeasure":null,
        "primaryMediumImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=475&width=475",
        "seoUrlSlugDerived":"Dora the Explorer - Season 1",
        "weight":null,
        "active":true,
        "thumbImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"
        ],
        "creationDate":"2010-07-14T14:03:46.000Z",
        "route":"/dora-the-explorer-season-1/product/Product_21Cxi",
        "relatedArticles":[
        ],
        "mediumImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=475&width=475"
        ],
        "primarySourceImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=300&width=300",
        "parentCategory":null,
        "sourceImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=300&width=300"
        ],
        "primarySmallImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=300&width=300",
        "avgCustRating":4.5,
        "longDescription":null,
        "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100",
        "nonreturnable":false,
        "displayName":"Dora the Explorer - Season 1",
        "description":"A really great movie that you should not miss.",
        "salePrices":null,
        "primaryFullImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg",
        "primaryLargeImageURL":"/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=940&width=940",
        "smallImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg&height=300&width=300"
        ],
        "derivedShippingSurchargeFrom":"defaultPriceGroup",
        "shippingSurcharges":null,
        "saleVolumePrices":null,
        "primaryImageTitle":"Dora the Explorer - Season 1",
        "saleVolumePrice":null,
        "childSKUs":[
            {
                "productFamily":null,
                "dynamicPropertyMapLong":{
                },
                "primaryThumbImageURL":null,
                "bundleLinks":[
                ],
                "largeImage":null,
                "smallImage":null,
                "listVolumePrice":null,
                "nonreturnable":false,
                "displayName":null,
                "onlineOnly":false,
                "salePrices":null,
                "primaryFullImageURL":null,
                "listPrices":null,
                "productListingSku":null,
                "largeImageURLs":[
                ],
                "productLine":null,
                "listVolumePrices":null,
                "primaryLargeImageURL":null,
                "derivedOnlineOnly":false,
                "smallImageURLs":[
                ],
                "derivedSalePriceFrom":"defaultPriceGroup",
                "model":null,
                "thumbnailImage":null,
                "barcode":"200000000196",
                "saleVolumePrices":null,
                "salePriceEndDate":null,
                "saleVolumePrice":null,
                "salePriceStartDate":null,
                "images":[
                ],
                "quantity":null,
                "unitOfMeasure":null,
                "salePrice":null,
                "primaryMediumImageURL":null,
                "fullImageURLs":[
                ],
                "dynamicPropertyMapBigString":{
                },
                "active":true,
                "thumbImageURLs":[
                ],
                "mediumImageURLs":[
                ],
                "repositoryId":"Sku_21Dxy",
                "derivedListPriceFrom":"defaultPriceGroup",
                "primarySourceImageURL":null,
                "primarySmallImageURL":null,
                "sourceImageURLs":[
                ],
                "listPrice":49.99,
                "configurable":false
            }
        ],
        "relatedMediaContent":[
        ],
        "salePrice":null,
        "fullImageURLs":[
            "/ccstore/v1/images/?source=/file/v5541415982230769347/products/doratheexplorer_season1_LARGE.jpg"
        ],
        "length":null,
        "variantValuesOrder":{
        },
        "notForIndividualSale":false,
        "repositoryId":"Product_21Cxi",
        "width":null,
        "derivedListPriceFrom":"defaultPriceGroup",
        "shippingSurcharge":null,
        "productImagesMetadata":[
            {
            }
        ],
        "configurable":false,
        "listPrice":49.99
    }
]

Default Response

The error response
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