1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Collections

getCollection

get

/ccadmin/v1/collections/{id}

Get Collection. Get a collection by ID. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Query Parameters
  • ID of catalog.
  • Depth of nested response from 0 to 6. Defaults to 0. NOTE: Caution should be used as increasing depth can negatively affect performance.
  • If set to childProducts, then childProducts will be expanded to include details.
  • If catalogId is a filtered view catalog then setting this param to true ensure the base products of the filtered view catalog are also returned as childProducts. If expand=childProducts then childProducts in the response will also have an isFilteredCatalogMember field that will be true for those products that are in the filtered view catalog.
  • This parameter is dependent on showCategoryPaths set to true. If the value is set to true then response returns multiCatalogCategoryPaths and multiCatalogCategoryIdPaths to display linked paths from multiple catalogs prepended with catalog name and id respectively. Default value of the parameter is false.
  • Boolean flag to determine whether to show or hide catalogsCount and catalogsInfo properties in the response. Default value is false.
  • If set to false then category path related properties, namely, categoryPaths, categoryIdPaths, multiCatalogCategoryPaths and multiCatalogCategoryIdPaths, are not returned. If set to true then categoryPaths and categoryIdPaths are returned. For multiCatalogCategoryPaths and multiCatalogCategoryIdPaths use multipleCategoryPaths parameter. Default value of the parameter is true.
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 : ancestorCategories
Type: array
Array of category objects.
Show Source
Nested Schema : catalogsInfo
Type: array
Array of associated catalog objects sorted by catalogId. With default configuration, only top 20 catalogs are returned.
Show Source
Nested Schema : categoryImages
Type: array
Array of category images.
Show Source
Nested Schema : categoryPaths
Type: array
Array of category paths.
Show Source
Nested Schema : childCategories
Type: array
Array of category objects.
Show Source
Nested Schema : childProducts
Type: array
Array of child products. Note, if the catalogId is a filtered view catalog then this will only include the products in that filtered view catalog unless the includeBaseCatalogProducts param is true.
Show Source
Nested Schema : fixedChildCategories
Type: array
Array of category objects.
Show Source
Nested Schema : fixedParentCategories
Type: array
Array of category objects.
Show Source
Nested Schema : keywords
Type: array
Array of keywords.
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 : parentCategory
Type: object
Default parent category of the category.
Show Source
Nested Schema : seoMetaInfo
Type: object
Seo meta info for category.
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 : metadata
Type: object
Seo meta info for category.
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":"Men's shoes for every occasion. Shop our collection of men's dress shoes, men's oxford shoes, moccasins and trainers from ATG Store.com.",
    "childProducts":[
        {
            "repositoryId":"xprod1042"
        },
        {
            "repositoryId":"xprod1047"
        },
        {
            "repositoryId":"xprod1044"
        },
        {
            "repositoryId":"xprod1043"
        }
    ],
    "catalogsCount":2,
    "keywords":[
        "mens shoes",
        "men's shoes",
        "mens dress shoes",
        "mens casual shoes",
        "men's casual shoes",
        "mens flip flops",
        "men's flip flops",
        "ATG Store.com footwear",
        "ATG Store.com"
    ],
    "categoryPaths":[
        "/Commerce Root/Shoes/Men's Shoes"
    ],
    "displayName":"Men's Shoes",
    "seoDescriptionDerived":"Men's Shoes, Men's shoes for every occasion. Shop our collection of men's dress shoes, men's oxford shoes, moccasins and trainers from ATG Store.com.",
    "description":"",
    "childCategories":null,
    "seoTitleDerived":"Men's Shoes",
    "seoMetaInfo":{
        "seoDescription":"Men's Shoes, Men's shoes for every occasion. Shop our collection of men's dress shoes, men's oxford shoes, moccasins and trainers from ATG Store.com.",
        "repositoryId":"100002",
        "seoTitle":"Men's Shoes",
        "seoKeywords":"Men's Shoes",
        "seoUrlSlug":"mens-shoes"
    },
    "catalogsInfo":[
        {
            "displayName":"Site Context Test Catalog",
            "repositoryId":"SiteContextDummyCatalog"
        },
        {
            "displayName":"QA Movie and Games Catalog",
            "repositoryId":"cloudLakeCatalog"
        }
    ],
    "multiCatalogCategoryPaths":[
        "CloudLake Catalog/Commerce Root/Shoes/Men's Shoes"
    ],
    "id":"cat50077",
    "childProductsCount":4,
    "categoryImages":[
        {
            "path":"/collections/mens-shoes.jpg",
            "metadata":{
                "altText":"Men's Shoes",
                "titleText":"Men's Shoes"
            },
            "name":"/collections/mens-shoes.jpg",
            "repositoryId":"m10002",
            "url":"http://localhost:9080/file/collections/mens-shoes.jpg"
        }
    ],
    "seoKeywordsDerived":"Men's Shoes",
    "fixedChildCategories":[
    ],
    "seoUrlSlugDerived":"mens-shoes",
    "fixedParentCategories":[
        {
            "repositoryId":"cat50097"
        }
    ],
    "route":"/mens-shoes/category/cat50077",
    "repositoryId":"cat50077",
    "name":null,
    "parentCategory":{
        "repositoryId":"cat50097"
    },
    "multiCatalogCategoryIdPaths":[
        "cloudLakeCatalog:rootCategory>m1002"
    ],
    "ancestorCategories":[
        {
            "repositoryId":"rootCategory"
        },
        {
            "repositoryId":"cat50097"
        }
    ]
}

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| |20140|Collection Id is invalid or non-existent| |200104|Catalog ID is invalid or not associated with current profile.| |200240|parentCategoryScope is not revertToBase but parentCategory is not in the request| |200241|parentCategory is not a parent of the collection| |200242|catalogSpecific or revertToBase parentCategoryScope but no catalog specified in the request| |200243|parentCategoryScope invalid/unknown value| |200244|catalogSpecific parentCategoryScope but parentCategory is not in the specified catalog|
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