getCatalog
get
/ccadmin/v1/catalogs/{id}
Get Catalog. Get a catalog 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: string
ID of catalog.
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 : getCatalog_response
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.
-
productCatalog(optional):
boolean
Boolean flag, true if this is the default product catalog for the system.
-
repositoryId(optional):
string
Repository ID.
-
rootCategories(optional):
array rootCategories
Array of categories associated with 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 : rootCategories
Type:
array
Array of categories associated with the catalog.
Show Source
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
Example Response (application/json)
{
"catalogVersion":2,
"defaultCategoryForProducts":"appleDefaultCategory",
"rootNavigationCategory":"cat10098",
"displayName":"Apple Catalog",
"repositoryId":"appleCatalog",
"rootCategories":[
{
"repositoryId":"cat10098"
},
{
"repositoryId":"cat10099"
}
],
"id":"appleCatalog",
"productCatalog":false
}
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|
|------------------|------------------|
|200105|Catalog not found|
|200102|Repository error|
|200104|Invalid catalog id.|
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