REST API for Oracle Commerce Cloud

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(required): string

ID of catalog.

Header Parameters

X-CCAsset-Language: 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: object

Show Source

baseCatalog: object baseCatalog

(Only present for filtered view catalogs) This references the independent catalog that is the base catalog for the filtered view.
catalogVersion: 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: string

Default category parent to link to new products created in this catalog if no other parents are specified.
displayName: string

Display name of the catalog.
id: string

Catalog ID.
lastModifiedDate: string

Date and timestamp when the item is modified recently.
productCatalog: boolean

Boolean flag, true if this is the default product catalog for the system.
repositoryId: string

Repository ID.
rootCategories: array rootCategories

Array of categories associated with the catalog.
rootNavigationCategory: object rootNavigationCategory

Navigation category for the catalog.

{
    "properties":{
        "catalogVersion":{
            "description":"Type of catalog to create.  1 = legacy catalog (only allowed if legacy catalog support is enabled), 2 = new style catalog, 3 = filtered view catalog.",
            "type":"integer"
        },
        "defaultCategoryForProducts":{
            "description":"Default category parent to link to new products created in this catalog if no other parents are specified.",
            "type":"string"
        },
        "rootNavigationCategory":{
            "description":"Navigation category for the catalog.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the navigation category",
                    "type":"string"
                }
            }
        },
        "baseCatalog":{
            "description":"(Only present for filtered view catalogs) This references the independent catalog that is the base catalog for the filtered view.",
            "type":"object",
            "properties":{
                "catalogVersion":{
                    "description":"Type of base catalog. For base catalog this will always be 2 - independent catalog.",
                    "type":"integer"
                },
                "defaultCategoryForProducts":{
                    "description":"Default category parent to link to new products created in this base catalog if no other parents are specified.",
                    "type":"string"
                },
                "rootNavigationCategory":{
                    "description":"Navigation category for the base catalog.",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository id of the navigation category",
                            "type":"string"
                        }
                    }
                },
                "displayName":{
                    "description":"Display name of the base catalog.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID.",
                    "type":"string"
                },
                "rootCategories":{
                    "description":"Array of root categories of the base catalog",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository id of category/collection",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "lastModifiedDate":{
            "description":"Date and timestamp when the item is modified recently.",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the catalog.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID.",
            "type":"string"
        },
        "rootCategories":{
            "description":"Array of categories associated with the catalog.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of category/collection",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"Catalog ID.",
            "type":"string"
        },
        "productCatalog":{
            "description":"Boolean flag, true if this is the default product catalog for the system.",
            "type":"boolean"
        }
    }
}

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

Type of base catalog. For base catalog this will always be 2 - independent catalog.
defaultCategoryForProducts: string

Default category parent to link to new products created in this base catalog if no other parents are specified.
displayName: string

Display name of the base catalog.
repositoryId: string

Repository ID.
rootCategories: array rootCategories

Array of root categories of the base catalog
rootNavigationCategory: object rootNavigationCategory

Navigation category for the base catalog.

{
    "description":"(Only present for filtered view catalogs) This references the independent catalog that is the base catalog for the filtered view.",
    "type":"object",
    "properties":{
        "catalogVersion":{
            "description":"Type of base catalog. For base catalog this will always be 2 - independent catalog.",
            "type":"integer"
        },
        "defaultCategoryForProducts":{
            "description":"Default category parent to link to new products created in this base catalog if no other parents are specified.",
            "type":"string"
        },
        "rootNavigationCategory":{
            "description":"Navigation category for the base catalog.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository id of the navigation category",
                    "type":"string"
                }
            }
        },
        "displayName":{
            "description":"Display name of the base catalog.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID.",
            "type":"string"
        },
        "rootCategories":{
            "description":"Array of root categories of the base catalog",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository id of category/collection",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : rootCategories

Type: array

Array of categories associated with the catalog.

Show Source

Array of: object items

{
    "description":"Array of categories associated with the catalog.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository id of category/collection",
                "type":"string"
            }
        }
    }
}

Nested Schema : rootNavigationCategory

Type: object

Navigation category for the catalog.

Show Source

repositoryId: string

Repository id of the navigation category

{
    "description":"Navigation category for the catalog.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the navigation category",
            "type":"string"
        }
    }
}

Nested Schema : rootCategories

Type: array

Array of root categories of the base catalog

Show Source

Array of: object items

{
    "description":"Array of root categories of the base catalog",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository id of category/collection",
                "type":"string"
            }
        }
    }
}

Nested Schema : rootNavigationCategory

Type: object

Navigation category for the base catalog.

Show Source

repositoryId: string

Repository id of the navigation category

{
    "description":"Navigation category for the base catalog.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of the navigation category",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

repositoryId: string

Repository id of category/collection

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of category/collection",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

repositoryId: string

Repository id of category/collection

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository id of category/collection",
            "type":"string"
        }
    }
}

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

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
errors: array errors

An optional list of errors if multiple errors were encountered
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code
type: string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}