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

getCollection

get

/ccstore/v1/collections/{id}

Get Collection. Get a collection by ID. 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. If 'rootCategory' is passed as a category id, actual root category of the catalog is picked up and considered. The endpoint also returns dynamic properties for a collection if exists.

Request

Supported Media Types
Path Parameters
Query Parameters
  • ID of the catalog.
  • False indicates category details are not returned if there are no active products under the category. True indicates category details are returned irrespective of the active products availability.
  • If set to childCategories, then child categories will be expanded to include details, if there are any active products under it. disableActiveProdCheck can be set to true in case the category details are needed irrespective of active products are available.
  • Maximum level of depth for child categories.Root category will be considered as zero and child category will be picked up upto given maxLevel after root category. If maxLevel is given as zero then it will not return any child category. If maxLevel parameter is not present in the request URI then all the child categories will be returned.
  • Return multiCatalogCategoryPaths and multiCatalogCategoryIdPaths to display linked paths from multiple catalogs prepended with catalog name and id respectively if the value is set to true. Default value of the parameter is false.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getCollection_response
Type: object
Show Source
Nested Schema : childCategories
Type: array
Array of category 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 : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "items":[
        {
            "longDescription":null,
            "route":"/for-him/category/cat50067",
            "dimensionId":"1234567890",
            "displayName":"For Him",
            "childCategories":[
                {
                    "longDescription":null,
                    "route":"/under-$25/category/cat90042",
                    "dimensionId":"1234567892",
                    "displayName":"Under $25",
                    "id":"cat90042",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/under-$50/category/cat90040",
                    "dimensionId":"1234567893",
                    "displayName":"Under $50",
                    "id":"cat90040",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                }
            ],
            "id":"cat50067",
            "creationDate":"2011-01-07T17:19:47.000Z"
        },
        {
            "longDescription":null,
            "route":"/for-her/category/cat60001",
            "dimensionId":"1234567891",
            "displayName":"For Her",
            "childCategories":[
                {
                    "longDescription":null,
                    "route":"/under-$25/category/cat90046",
                    "dimensionId":"1234567894",
                    "displayName":"Under $25",
                    "id":"cat90046",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/under-$50/category/cat90026",
                    "dimensionId":"1234567895",
                    "displayName":"Under $50",
                    "id":"cat90026",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-romantic/category/cat90028",
                    "dimensionId":"1234567896",
                    "displayName":"For the Romantic",
                    "id":"cat90028",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-fashionista/category/cat90037",
                    "dimensionId":"1234567897",
                    "displayName":"For the Fashionista",
                    "id":"cat90037",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-outdoor-lover/category/cat90034",
                    "dimensionId":"1234567898",
                    "displayName":"For the Outdoor Lover",
                    "id":"cat90034",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                }
            ],
            "id":"cat60001",
            "creationDate":"2011-01-07T17:19:47.000Z"
        }
    ]
}

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