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
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listCatalogs_response
Type: object
Show Source
Nested Schema : items
Type: array
List of catalogs
Show Source
Nested Schema : sort
Type: array
List of properties being sorted.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : rootCategories
Type: array
Array of root categories of the catalog
Show Source
Nested Schema : rootNavigationCategory
Type: object
Navigation category for the catalog.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "items":[
        {
            "catalogVersion":2,
            "defaultCategoryForProducts":"appleDefaultCategory",
            "rootNavigationCategory":"cat10098",
            "displayName":"Apple Catalog",
            "repositoryId":"appleCatalog",
            "rootCategories":[
                {
                    "repositoryId":"cat10098"
                },
                {
                    "repositoryId":"cat10099"
                }
            ],
            "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
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