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

updateLayout

put

/ccadmin/v1/layouts/{id}

Update Layout. Update a layout by layout ID and request parameters. Layout will have dynamic properties which change from one layout to another.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateLayout_request
Type: object
Show Source
Example:
{
    "properties":{
        "urlSlug":"",
        "defaultPage":false,
        "notes":"home update test",
        "seoMetaDescription":null,
        "seoMetaKeywords":null,
        "displayName":"Home",
        "pageTitle":null,
        "sites":[
            "100001"
        ],
        "skuIds":[
            "productId: 123"
        ],
        "target":100,
        "seoMetadataLayoutPreviewTitle":null,
        "layoutCollections":[
            "Gift Shop / For Him / Under $25 (ca90042)"
        ],
        "pageAddress":"aboutUs3",
        "pageDisplayName":"CTEST",
        "repositoryId":"homePageLayout",
        "metaTags":"",
        "orderStates":[
            "FAILED_APPROVAL"
        ],
        "layoutViewports":"xs,sm",
        "links":[
            "http://localhost:9080/occ-admin/"
        ],
        "collectionId":[
            "ca90042"
        ],
        "contentType":""
    }
}
Nested Schema : properties
Type: object
List of properties of the layout.
Show Source
Nested Schema : collectionId
Type: array
ID for collection. Displayed on collection layouts
Show Source
Nested Schema : layoutCollections
Type: array
The layout of the chosen selection. Displayed on Collection layouts.
Show Source
Nested Schema : orderStates
Type: array
Layout will only be used for order statuses you select. Displayed on Checkout layout.
Show Source
Nested Schema : sites
Type: array
Sites associated with this layout. Displayed on all layouts.
Show Source
Nested Schema : skuIds
Type: array
ProductID's for up to 5 products
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateLayout_response
Type: object
Show Source
Example Response (application/json)
{
    "seoMetaDescription":"",
    "notes":"home update test",
    "seoMetaKeywords":"",
    "pageTitle":"",
    "displayName":"Home",
    "repositoryId":"homePageLayout"
}

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| |------------------|------------------| |32003|Error updating a layout.| |25100|Internal Error| |32020|The specified page address {0} must be unique.|
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