REST API for Oracle Commerce Cloud December 2017

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

application/json

Path Parameters

id: Type: string

Required: true

ID of catalog.

Header Parameters

X-CCAsset-Language: Type: string

Required: true

The asset language of the request

Body Parameter

Root Schema : updateCatalog_request

Example


{
    "op":"add",
    "categoryIds":[
        "cat10022"
    ],
    "displayName":"Apple Catalog"
}

Properties

categoryIds: Type: array categoryIds

Additional Properties Allowed:

List of category Ids to be associated or deassociated with this catalog.
displayName: Type: string

Display name of the catalog.
op: Type: string

If op is passed as a parameter, it should be either add or remove. If it is not specified, previous categories will be overwritten.

Nested Schema : categoryIds

Type: array

List of category Ids to be associated or deassociated with this catalog.

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateCatalog_response

Properties

displayName: Type: string

Display name of the catalog.
id: Type: string

Catalog ID.
repositoryId: Type: string

Repository ID.
rootCategories: Type: array rootCategories

Additional Properties Allowed:

Array of categories associated with the catalog.

Nested Schema : rootCategories

Type: array

Array of categories associated with the catalog.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository id of category/collection

Example application/json


{
    "displayName":"Apple Catalog",
    "repositoryId":"appleCatalog",
    "rootCategories":[
        {
            "repositoryId":"cat10022"
        }
    ],
    "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

Properties

devMessage: Type: string

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

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

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

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

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

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code

Examples

Sample Request:

{
  "op": "add",
  "categoryIds": ["cat10022"],
  "displayName": "Apple Catalog"
}

Sample Response Payload returned by endpoint:

{
  "displayName": "Apple Catalog",
  "repositoryId": "appleCatalog",
  "rootCategories": [{"repositoryId": "cat10022"}],
  "id": "appleCatalog"
}