REST API for Oracle Commerce Cloud December 2017

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

application/json

Path Parameters

id: Type: string

Required: true

ID of collection.

Query Parameters

catalogId: Type: string

ID of catalog.
depth: Type: string

Depth of search, either 'max' or 'min'.
expand: Type: string

If set to childCategories, then childCategories will be expanded to include details. If set to childProducts, then childProducts will be expanded to include details.

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


{
    "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"
        }
    ],
    "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"
    ],
    "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"
        }
    ],
    "categoryPaths":[
        "/Commerce Root/Shoes/Men's Shoes"
    ],
    "displayName":"Men's Shoes",
    "seoKeywordsDerived":"Men's Shoes",
    "fixedChildCategories":[
    ],
    "seoUrlSlugDerived":"mens-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,
    "fixedChildProducts":[
        {
            "repositoryId":"xprod1042"
        },
        {
            "repositoryId":"xprod1047"
        },
        {
            "repositoryId":"xprod1044"
        },
        {
            "repositoryId":"xprod1043"
        }
    ],
    "seoTitleDerived":"Men's Shoes",
    "fixedParentCategories":[
        {
            "repositoryId":"cat50097"
        }
    ],
    "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"
    },
    "route":"/mens-shoes/category/cat50077",
    "repositoryId":"cat50077",
    "name":"cat50077",
    "ancestorCategories":[
        {
            "repositoryId":"rootCategory"
        },
        {
            "repositoryId":"cat50097"
        }
    ],
    "id":"cat50077"
}

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| |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": "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"}
  ],
  "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"
  ],
  "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"
  }],
  "categoryPaths": ["/Commerce Root/Shoes/Men's Shoes"],
  "displayName": "Men's Shoes",
  "seoKeywordsDerived": "Men's Shoes",
  "fixedChildCategories": [],
  "seoUrlSlugDerived": "mens-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,
  "fixedChildProducts": [
    {"repositoryId": "xprod1042"},
    {"repositoryId": "xprod1047"},
    {"repositoryId": "xprod1044"},
    {"repositoryId": "xprod1043"}
  ],
  "seoTitleDerived": "Men's Shoes",
  "fixedParentCategories": [{"repositoryId": "cat50097"}],
  "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"
  },
  "route": "/mens-shoes/category/cat50077",
  "repositoryId": "cat50077",
  "name": "cat50077",
  "ancestorCategories": [
    {"repositoryId": "rootCategory"},
    {"repositoryId": "cat50097"}
  ],
  "id": "cat50077"
}