REST API for Oracle Commerce Cloud December 2017

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

application/json

Query Parameters

catalogId: Type: string

ID of the catalog.
categoryIds: Type: string

Required: true

List of category IDs.

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

Properties

items: Type: array items

Additional Properties Allowed:

The array of category objects.

Nested Schema : items

Type: array

The array of category objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

active: Type: boolean

Whether or not the category is active
categoryImages: Type: array categoryImages

Additional Properties Allowed:

Array of category images.
categoryPaths: Type: array categoryPaths

Additional Properties Allowed:

An array of category paths.
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 fixed child 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 : categoryImages

Type: array

Array of category images.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : categoryPaths

Type: array

An array of category paths.

Items

Type: string

Nested Schema : childCategories

Type: array

Array of category objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : fixedParentCategories

Type: array

Array of fixed child category objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

metadata: Type: object metadata

Additional Properties Allowed:

Category Image Metadata.
name: Type: string

Image Name.
path: Type: string

Image Path.
repositoryId: Type: string

Repository ID of Image Media.
url: Type: string

Image URL.

Nested Schema : metadata

Type: object

Category Image Metadata.

Properties

altText: Type: string

Alt text for category image.
titleText: Type: string

Title text for category image.

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository ID of the child category.

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository id of parent category.

Example 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",
                "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",
                "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",
                "id":"rootCategory"
            }
        ],
        "creationDate":"2011-01-07T17:19:47.000Z",
        "route":"/gift-shop/category/cat50056",
        "dimensionId":"943609061",
        "repositoryId":"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

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:

[{
  "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",
      "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",
      "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",
    "id": "rootCategory"
  }],
  "creationDate": "2011-01-07T17:19:47.000Z",
  "route": "/gift-shop/category/cat50056",
  "dimensionId": "943609061",
  "repositoryId": "cat50056",
  "id": "cat50056"
}]