REST API for Oracle Commerce Cloud December 2017

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.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID of collection.

Query Parameters

catalogId: Type: string

ID of the catalog.
disableActiveProdCheck: Type: boolean

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.
expand: Type: string

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.
maxLevel: Type: string

Maximum level of depth for child categories.

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 : getCollection_response

Properties

childCategories: Type: array childCategories

Additional Properties Allowed:

Array of category objects.
creationDate: Type: string

product creation date
dimensionId: Type: string

Dimension ID.
displayName: Type: string

Display Name of the category.
fixedParentCategories: Type: array fixedParentCategories

Additional Properties Allowed:

Array of category objects.
id: Type: string

Category ID.
longDescription: Type: string

Long description of the category.
repositoryId: Type: string

Repository ID.
route: Type: string

Route of the category.

Nested Schema : childCategories

Type: array

Array of category objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : fixedParentCategories

Type: array

Array of category objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

creationDate: Type: string

product creation date
displayName: Type: string

Display name of the child category.
id: Type: string

ID of the child category.
longDescription: Type: string

Long description of the child category.
route: Type: string

Route of the child category.

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository id of parent category.

Example application/json


{
    "items":[
        {
            "longDescription":null,
            "route":"/for-him/category/cat50067",
            "displayName":"For Him",
            "childCategories":[
                {
                    "longDescription":null,
                    "route":"/under-$25/category/cat90042",
                    "displayName":"Under $25",
                    "id":"cat90042",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/under-$50/category/cat90040",
                    "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",
            "displayName":"For Her",
            "childCategories":[
                {
                    "longDescription":null,
                    "route":"/under-$25/category/cat90046",
                    "displayName":"Under $25",
                    "id":"cat90046",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/under-$50/category/cat90026",
                    "displayName":"Under $50",
                    "id":"cat90026",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-romantic/category/cat90028",
                    "displayName":"For the Romantic",
                    "id":"cat90028",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-fashionista/category/cat90037",
                    "displayName":"For the Fashionista",
                    "id":"cat90037",
                    "creationDate":"2011-01-07T17:19:47.000Z"
                },
                {
                    "longDescription":null,
                    "route":"/for-the-outdoor-lover/category/cat90034",
                    "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{"items": [
  {
    "longDescription": null,
    "route": "/for-him/category/cat50067",
    "displayName": "For Him",
    "childCategories": [
      {
        "longDescription": null,
        "route": "/under-$25/category/cat90042",
        "displayName": "Under $25",
        "id": "cat90042",
        "creationDate": "2011-01-07T17:19:47.000Z"
      },
      {
        "longDescription": null,
        "route": "/under-$50/category/cat90040",
        "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",
    "displayName": "For Her",
    "childCategories": [
      {
        "longDescription": null,
        "route": "/under-$25/category/cat90046",
        "displayName": "Under $25",
        "id": "cat90046",
        "creationDate": "2011-01-07T17:19:47.000Z"
      },
      {
        "longDescription": null,
        "route": "/under-$50/category/cat90026",
        "displayName": "Under $50",
        "id": "cat90026",
        "creationDate": "2011-01-07T17:19:47.000Z"
      },
      {
        "longDescription": null,
        "route": "/for-the-romantic/category/cat90028",
        "displayName": "For the Romantic",
        "id": "cat90028",
        "creationDate": "2011-01-07T17:19:47.000Z"
      },
      {
        "longDescription": null,
        "route": "/for-the-fashionista/category/cat90037",
        "displayName": "For the Fashionista",
        "id": "cat90037",
        "creationDate": "2011-01-07T17:19:47.000Z"
      },
      {
        "longDescription": null,
        "route": "/for-the-outdoor-lover/category/cat90034",
        "displayName": "For the Outdoor Lover",
        "id": "cat90034",
        "creationDate": "2011-01-07T17:19:47.000Z"
      }
    ],
    "id": "cat60001",
    "creationDate": "2011-01-07T17:19:47.000Z"
  }
]}