listCollections

get

/ccstore/v1/collections

List Collections. Gets a list of collections based on category IDs. 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.

Request

Supported Media Types
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listCollections_response
Type: object
Show Source
Nested Schema : items
Type: array
The array of collection items.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : categoryImages
Type: array
The category images.
Show Source
Nested Schema : categoryPaths
Type: array
An array of category paths.
Show Source
Nested Schema : childCategories
Type: array
Array of category objects.
Show Source
Nested Schema : childProducts
Type: array
Array of product objects
Show Source
Nested Schema : fixedParentCategories
Type: array
Array of category objects.
Show Source
Nested Schema : multiCatalogCategoryIdPaths
Type: array
An array of category ids in the path prepended with catalog id
Show Source
Nested Schema : multiCatalogCategoryPaths
Type: array
An array of category paths prepended with catalog name
Show Source
Nested Schema : sort
Type: array
Array having the order and property of collection.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
[
    {
        "longDescription":null,
        "categoryImages":[
            {
                "path":"/collections/DSC_0590.JPG",
                "metadata":{
                    "altText":"GiftShop",
                    "titleText":"GiftShop"
                },
                "repositoryId":"m10001",
                "name":"/collections/giftshop.JPG",
                "url":"http://localhost:9080/file/v5688338524333816125/collections/giftshop.JPG",
                "tags":[
                ]
            }
        ],
        "displayName":"Gift Shop",
        "categoryPaths":[
            "/Storefront Navigation/Gift Shop"
        ],
        "active":true,
        "description":null,
        "categoryIdPaths":[
            "rootCategory>cat50056"
        ],
        "childCategories":[
            {
                "longDescription":null,
                "categoryImages":[
                ],
                "displayName":"For Him",
                "categoryPaths":[
                    "/Storefront Navigation/Gift Shop/For Him"
                ],
                "active":true,
                "description":null,
                "categoryIdPaths":[
                    "rootCategory>cat50056>cat50067"
                ],
                "childCategories":[
                    {
                        "repositoryId":"cat90042"
                    },
                    {
                        "repositoryId":"cat90040"
                    }
                ],
                "creationDate":"2011-01-07T17:19:47.000Z",
                "fixedParentCategories":[
                    {
                        "repositoryId":"cat50056"
                    }
                ],
                "route":"/for-him/category/cat50067",
                "repositoryId":"cat50067",
                "multiCatalogCategoryPaths":[
                    "/CloudLake Catalog/Storefront Navigation/Gift Shop/For Him"
                ],
                "multiCatalogCategoryIdPaths":[
                    "cloudLakeCatalog>rootCategory>cat50056>cat50067"
                ],
                "id":"cat50067"
            },
            {
                "longDescription":null,
                "categoryImages":[
                ],
                "displayName":"For Her",
                "categoryPaths":[
                    "/Storefront Navigation/Gift Shop/For Her"
                ],
                "active":true,
                "description":null,
                "categoryIdPaths":[
                    "rootCategory>cat50056>cat60001"
                ],
                "childCategories":[
                    {
                        "repositoryId":"cat90046"
                    },
                    {
                        "repositoryId":"cat90026"
                    },
                    {
                        "repositoryId":"cat90028"
                    },
                    {
                        "repositoryId":"cat90037"
                    },
                    {
                        "repositoryId":"cat90034"
                    }
                ],
                "creationDate":"2011-01-07T17:19:47.000Z",
                "fixedParentCategories":[
                    {
                        "repositoryId":"cat50056"
                    }
                ],
                "route":"/for-her/category/cat60001",
                "repositoryId":"cat60001",
                "multiCatalogCategoryPaths":[
                    "/CloudLake Catalog/Storefront Navigation/Gift Shop/For Her"
                ],
                "multiCatalogCategoryIdPaths":[
                    "cloudLakeCatalog>rootCategory>cat50056>cat60001"
                ],
                "id":"cat60001"
            }
        ],
        "fixedParentCategories":[
            {
                "longDescription":"Commerce Cloud Root Category",
                "categoryImages":[
                ],
                "displayName":"Storefront Navigation",
                "categoryPaths":[
                    "/Storefront Navigation"
                ],
                "active":true,
                "description":null,
                "categoryIdPaths":[
                    "rootCategory"
                ],
                "childCategories":[
                    {
                        "repositoryId":"cat50056"
                    },
                    {
                        "repositoryId":"cat90016"
                    },
                    {
                        "repositoryId":"homeStoreRootCategory"
                    }
                ],
                "creationDate":"2011-01-07T17:19:47.000Z",
                "fixedParentCategories":[
                ],
                "route":"/storefront-navigation/category/rootCategory",
                "repositoryId":"rootCategory",
                "multiCatalogCategoryPaths":[
                    "/CloudLake Catalog/Storefront Navigation"
                ],
                "multiCatalogCategoryIdPaths":[
                    "cloudLakeCatalog>rootCategory"
                ],
                "id":"rootCategory"
            }
        ],
        "creationDate":"2011-01-07T17:19:47.000Z",
        "route":"/gift-shop/category/cat50056",
        "dimensionId":"943609061",
        "repositoryId":"cat50056",
        "multiCatalogCategoryPaths":[
            "/CloudLake Catalog/Storefront Navigation/Gift Shop"
        ],
        "multiCatalogCategoryIdPaths":[
            "cloudLakeCatalog>rootCategory>cat50056"
        ],
        "id":"cat50056"
    }
]

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| |------------------|------------------| |20142|Get Category Id Type Internal Error| |20141|Collection Id passed is null or empty| |20052|Get List Collections Type Internal Error| |20140|Collection Id is invalid or non-existent|
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