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
-
baseCatalogId(optional): string
This param restricts the list to only include catalogs with the given base catalog id.
-
catalogVersion(optional): string
This param is a comma separated list of catalog versions to filter the list of catalogs by. Valid values are 1-3.
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
productId(optional): string
This param restricts the list to only include catalogs the product is a member of.
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across catalog properties like 'name'.
-
showAccessControlInfo(optional): boolean
Boolean flag to determine whether to show currently logged in user's access control information for the catalogs in the response. Default value is false.
-
sort(optional): string
This field determines the sort order of the list to be fetched.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listCatalogs_response
Type:
Show Source
object
-
items(optional):
array items
List of catalogs
-
limit(optional):
integer
Limit of number of catalogs.
-
offset(optional):
integer
Offset of catalog inventory.
-
sort(optional):
array sort
List of properties being sorted.
-
total(optional):
integer
Total number of catalogs.
-
totalResults(optional):
integer
Total number of catalogs.
Nested Schema : items
Type:
Show Source
object
-
baseCatalog(optional):
object baseCatalog
(Only present for filtered view catalogs) This references the independent catalog that is the base catalog for the filtered view.
-
catalogVersion(optional):
integer
Type of catalog to create. 1 = legacy catalog (only allowed if legacy catalog support is enabled), 2 = new style catalog, 3 = filtered view catalog.
-
defaultCategoryForProducts(optional):
string
Default category parent to link to new products created in this catalog if no other parents are specified.
-
displayName(optional):
string
Display name of the catalog.
-
id(optional):
string
Catalog ID.
-
repositoryId(optional):
string
Repository ID.
-
rootCategories(optional):
array rootCategories
Array of root categories of the catalog
- rootNavigationCategory(optional): object rootNavigationCategory
Nested Schema : baseCatalog
Type:
object
(Only present for filtered view catalogs) This references the independent catalog that is the base catalog for the filtered view.
Show Source
-
catalogVersion(optional):
integer
Type of base catalog. For base catalog this will always be 2 - independent catalog.
-
defaultCategoryForProducts(optional):
string
Default category parent to link to new products created in this base catalog if no other parents are specified.
-
displayName(optional):
string
Display name of the base catalog.
-
repositoryId(optional):
string
Repository ID.
-
rootCategories(optional):
array rootCategories
Array of root categories of the base catalog
- rootNavigationCategory(optional): object rootNavigationCategory
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository id of category/collection
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
Repository id of category/collection
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
The order by which the property is sorted.
-
property(optional):
string
The property being sorted.
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|
|200229|Invalid catalog version|
|20031|Product not found|
|20032|Product id is blank|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code