1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Catalogs

updateCatalog

put

/ccadmin/v1/catalogs/{id}

Update a catalog by ID. **Requires the x-ccasset-language header so translated content can be set for a specific language.** While using this API, be sure to review the expected behavior for "op" property in the request body. If "op" property is not specified, previous categories under Storefront Navigation will be removed from the catalog. When using the API to update catalog properties, set "op"="add" in the request body to avoid previous categories being removed from the catalog.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateCatalog_request
Type: object
Show Source
  • categoryIds
    (not valid for filtered view catalogs) List of category Ids to be associated or deassociated with this catalog. Categories are set as children of the root navigation category.
  • (not valid for filtered view catalogs) Default category to link to new products created in this catalog if no other parents are specified. If it is not set then the new products would instead be created unassigned.
  • Display name of the catalog.
  • (not valid for filtered view catalogs) If op is passed as a parameter, it should be either add or remove. If it is not specified, previous categories will be overwritten.
Example:
{
    "op":"add",
    "categoryIds":[
        "cat10022"
    ],
    "displayName":"Apple Catalog"
}
Nested Schema : categoryIds
Type: array
(not valid for filtered view catalogs) 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 : 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
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 : rootCategories
Type: array
Array of root categories of the base catalog
Show Source
Nested Schema : rootNavigationCategory
Type: object
Navigation category for the base catalog.
Show Source
Nested Schema : items
Type: object
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"
}

412 Response

ETag mismatch. Asset has been updated by another user.

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.| |200247|Category input fields are invalid for filtered view catalogs.| |200248| It is not allowed to update the base catalog after creation.|
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