REST API for Oracle Commerce Cloud December 2017

listCatalogs

get

/ccadmin/v1/catalogs

List Catalogs. Get a list of catalogs. Use the name query param to list the catalogs whose display name CONTAINS IGNORECASE the given search string. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Query Parameters

limit: Type: string

This is the field to determine number of records to be fetched per REST call.
offset: Type: string

This field determines the offset/starting index from which data to be fetched.
q: Type: string

Query string built as per the SCIM standards that helps to search entered string across catalog properties like 'name'.
sort: Type: string

This field determines the sort order of the list to be fetched.

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

Properties

items: Type: array items

Additional Properties Allowed:

List of catalogs
limit: Type: integer

Limit of number of catalogs.
offset: Type: integer

Offset of catalog inventory.
sort: Type: array sort

Additional Properties Allowed:

List of properties being sorted.
total: Type: integer

Total number of catalogs.
totalResults: Type: integer

Total number of catalogs.

Nested Schema : items

Type: array

List of catalogs

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

List of properties being sorted.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

displayName: Type: string

Display name of the catalog.
id: Type: string

Catalog ID.
repositoryId: Type: string

Repository ID.
rootCategories: Type: array rootCategories

Additional Properties Allowed:

Array of root categories of the catalog

Nested Schema : rootCategories

Type: array

Array of root categories of the catalog

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository id of category/collection

Nested Schema : items

Type: object

Properties

order: Type: string

The order by which the property is sorted.
property: Type: string

The property being sorted.

Example application/json


{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "items":[
        {
            "displayName":"Apple Catalog",
            "repositoryId":"appleCatalog",
            "rootCategories":[
                {
                    "repositoryId":"cat10022"
                }
            ],
            "id":"appleCatalog"
        }
    ]
}

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| |------------------|------------------| |100070|Invalid search query expression| |200110|Internal error| |200108|Empty query options| |200107|Invalid input|

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:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 1,
  "items": [{
    "displayName": "Apple Catalog",
    "repositoryId": "appleCatalog",
    "rootCategories": [{"repositoryId": "cat10022"}],
    "id": "appleCatalog"
  }]
}