1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Collections

listCollections

get

/ccadmin/v1/collections

List Collections. Get a list of collections. Use the name query param to list the collections whose display name CONTAINS IGNORECASE the given search string. Use the categoryIds param to get a list of collections whose ids match those listed in the comma delimted string value. Either categoryIds or name must be provided. Optionally takes the x-ccasset-language header to get translated content in another language. To get the list of included/excluded collections, use a group of {promotionId, itemTypeList and templateValue} parameters together.

Request

Supported Media Types
  • application/json
Query Parameters
catalogId
Type: string
ID of catalog.
categoryIds
Type: string
Required: true
List of collection ids to get.
continueOnMissingCategory
Type: boolean
boolean flag to determine whether to continue if a category is missing.
depth
Type: string
Depth of search, can only be set to 'min' which is set to 2. This parameter can only be used with categoryIds and by default depth is set to 4.
itemTypeList
Type: string
Type of collection list to be fetched from the given promotion id -includedCategories or excludedCategories
minimalFieldsForNavigation
Type: boolean
Return minimum fields required for category navigation
name
Type: string
Required: true
Partial display name or id of a collection.
onlyActive
Type: boolean
Only return active categories when it is true, when set to false or by default, returns all the categories
pageResults
Type: boolean
Return response with paginated pattern
promotionId
Type: string
Promotion id to fetch the included/excluded collection list from, if promotionId is included then include the itemTypeList and templateValue parameters to get the include/exclude collection list for the promotion
q
Type: string
A SCIM filter string for selecting a subset of all collections. See [https://tools.ietf .org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools .ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format . Examples: Get all collections whose displayName contains shirt: q=displayName co "shirt" Get all child collections for collection with id shoes: q=fixedParentCategories co "shoes" Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted. The following collection properties can be used in a q query: * categoryImages * creationDate * description * displayName * fixedParentCategories * id * longDescription * fixedChildProducts
templateValue
Type: string
Template value to fetch the included/excluded collection list from - e.g PSC_Value
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
Nested Schema : items
Type: array
The array of category objects.
Nested Schema : items
Type: object
Nested Schema : categoryImages
Type: array
Array of category images.
Nested Schema : categoryPaths
Type: array
An array of category paths.
Nested Schema : childCategories
Type: array
Array of category objects.
Nested Schema : fixedParentCategories
Type: array
Array of fixed child category objects.
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Category Image Metadata.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "longDescription":"Looking for an inspired quality gift? ATG Store gift shop has a wide choice of gifts for both men and women suitable for every occassion. Shopping for gifts is simple and convenient at ATG Store.com.",
    "route":"/gift-shop/category/cat50056",
    "categoryPaths":[
        "/Commerce Root/Gift Shop"
    ],
    "displayName":"Gift Shop",
    "repositoryId":"cat50056",
    "active":false,
    "childCategories":[
        {
            "longDescription":"Looking for gift ideas for him? Let us help you find that perfect gift for him at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.",
            "route":"/for-him/category/cat50067",
            "categoryPaths":[
                "/Commerce Root/Gift Shop/For Him"
            ],
            "displayName":"For Him",
            "repositoryId":"cat50067",
            "active":false,
            "childCategories":null,
            "id":"cat50067",
            "fixedParentCategories":[
                {
                    "repositoryId":"cat50056"
                }
            ]
        },
        {
            "longDescription":"Looking for gift ideas for her? Find that amazing gift that she'll love at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.",
            "route":"/for-her/category/cat60001",
            "categoryPaths":[
                "/Commerce Root/Gift Shop/For Her"
            ],
            "displayName":"For Her",
            "repositoryId":"cat60001",
            "active":false,
            "childCategories":null,
            "id":"cat60001",
            "fixedParentCategories":[
                {
                    "repositoryId":"cat50056"
                }
            ]
        }
    ],
    "id":"cat50056",
    "fixedParentCategories":[
        {
            "longDescription":"ATG Store commerce root",
            "route":"/commerce-root/category/rootCategory",
            "categoryPaths":[
                "/Commerce Root"
            ],
            "displayName":"Commerce Root",
            "repositoryId":"rootCategory",
            "active":false,
            "childCategories":[
                {
                    "repositoryId":"cat50056"
                },
                {
                    "repositoryId":"cat50001"
                },
                {
                    "repositoryId":"catMen"
                },
                {
                    "repositoryId":"cat50097"
                },
                {
                    "repositoryId":"homeStoreRootCategory"
                },
                {
                    "repositoryId":"cat90028"
                },
                {
                    "repositoryId":"cat90030"
                }
            ],
            "id":"rootCategory",
            "fixedParentCategories":[
            ]
        }
    ],
    "creationDate":"2017-01-09T05:09:29.000Z"
}
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| |------------------|------------------| |21169|invalid template value incorrect_value.| |21168|templateValue is a required property for this request| |21167|itemTypeList is a required property for this request| |21001|Promotion not found for the given id: invalidId| |20142|Get Category Id Type Internal Error| |21165|itemTypeList can either be includedCategories or excludedCategories for this request| |20141|Collection Id passed is null or empty| |20053|The collection view does not support queries containing parameters| |20052|Get List Collections Type Internal Error| |20140|Collection Id is invalid or non-existent| |84000|Conflicting query parameters: promotionId, name| |21170|promotionId is a required property for this request|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "longDescription": "Looking for an inspired quality gift? ATG Store gift shop has a wide choice of gifts for both men and women suitable for every occassion. Shopping for gifts is simple and convenient at ATG Store.com.",
  "route": "/gift-shop/category/cat50056",
  "categoryPaths": ["/Commerce Root/Gift Shop"],
  "displayName": "Gift Shop",
  "repositoryId": "cat50056",
  "active": false,
  "childCategories": [
    {
      "longDescription": "Looking for gift ideas for him? Let us help you find that perfect gift for him at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.",
      "route": "/for-him/category/cat50067",
      "categoryPaths": ["/Commerce Root/Gift Shop/For Him"],
      "displayName": "For Him",
      "repositoryId": "cat50067",
      "active": false,
      "childCategories": null,
      "id": "cat50067",
      "fixedParentCategories": [{"repositoryId": "cat50056"}]
    },
    {
      "longDescription": "Looking for gift ideas for her? Find that amazing gift that she'll love at ATG Store. Shopping for gifts is simple and convenient at ATG Store.com.",
      "route": "/for-her/category/cat60001",
      "categoryPaths": ["/Commerce Root/Gift Shop/For Her"],
      "displayName": "For Her",
      "repositoryId": "cat60001",
      "active": false,
      "childCategories": null,
      "id": "cat60001",
      "fixedParentCategories": [{"repositoryId": "cat50056"}]
    }
  ],
  "id": "cat50056",
  "fixedParentCategories": [{
    "longDescription": "ATG Store commerce root",
    "route": "/commerce-root/category/rootCategory",
    "categoryPaths": ["/Commerce Root"],
    "displayName": "Commerce Root",
    "repositoryId": "rootCategory",
    "active": false,
    "childCategories": [
      {"repositoryId": "cat50056"},
      {"repositoryId": "cat50001"},
      {"repositoryId": "catMen"},
      {"repositoryId": "cat50097"},
      {"repositoryId": "homeStoreRootCategory"},
      {"repositoryId": "cat90028"},
      {"repositoryId": "cat90030"}
    ],
    "id": "rootCategory",
    "fixedParentCategories": []
  }],
  "creationDate": "2017-01-09T05:09:29.000Z"
}