Get a layout

get

/ccstore/v1/pages/layout/{path: .*}

This returns the layout data for a specific page. This data is used by the client to arrange how the page is displayed.

You can use additional request parameters to tailor what information is returned.

This endpoint can perform specific functionality that only works when running the storefront on a preview server. See Store Preview for more information. You can configure this behavior using the request parameters.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

The following model is returned when the operation is successful:
Body ()
Root Schema : getLayout_response
Type: object
Show Source
Nested Schema : regions
Type: array
The region data for all the regions of a page.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "layout":"homePageLayout",
    "regions":[
        {
            "id":"headerRegionHomePage"
        },
        {
            "id":"megaMenuRegionHomePage"
        },
        {
            "id":"footerRegionHomePage"
        },
        {
            "id":"globalWidgetsRegion0"
        }
    ],
    "route":"/home",
    "isPreview":true,
    "keywords":"",
    "viewports":"",
    "metaTags":[
    ],
    "description":"",
    "title":"Commerce Cloud Site"
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error CodeDescriptionPossible Fix
32010Invalid layout IDCheck the layout ID is correct and the layout exists.
32001Internal server error.See returned error messages for more information.

The following model is returned when an operation is unsuccessful:

The error response:
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