updateCatalog

put

/ccadmin/v1/catalogs/{id}

Update Catalog. Update a catalog by ID. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateCatalog_request
Type: object
Show Source
Example:
{
    "op":"add",
    "categoryIds":[
        "cat10022"
    ],
    "displayName":"Apple Catalog"
}
Nested Schema : categoryIds
Type: array
List of category Ids to be associated or deassociated with this catalog. Categories are set as children of the root navigation category.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateCatalog_response
Type: object
Show Source
Nested Schema : rootCategories
Type: array
Array of categories associated with the catalog.
Show Source
Nested Schema : rootNavigationCategory
Type: object
Navigation category for the catalog.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "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| |------------------|------------------| |200105|Catalog not found.| |200102|Catalog repository error.| |200101|Catalog name is blank.| |200104|Invalid catalog ID.|
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