listLayouts

get

/ccadmin/v1/layouts

List Layouts. List all the layouts.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listLayouts_response
Type: object
Show Source
Nested Schema : items
Type: array
Array of objects.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : pageLayout
Type: array
Displays page Layout
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : layout
Type: object
Layout with Dynamic Properties.
Show Source
Example Response (application/json)
[
    {
        "pageLayouts":[
            {
                "layout":{
                    "seoMetadataLayoutPreviewTitle":null,
                    "defaultPage":true,
                    "seoMetaDescription":"",
                    "notes":null,
                    "pageAddress":"home",
                    "seoMetaKeywords":"",
                    "pageTitle":"",
                    "displayName":"Home Layout",
                    "repositoryId":"homePageLayout",
                    "layoutViewports":""
                },
                "defaultPage":true,
                "pageType":"home",
                "route":"/home",
                "pageTypeId":"homePageType",
                "displayName":"Home",
                "name":"home",
                "repositoryId":"homePage"
            }
        ],
        "displayName":"Home",
        "shortName":"home"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "layoutCollections":"",
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"category",
                    "layoutPreviewTitle":null,
                    "displayName":"Collection Layout",
                    "repositoryId":"catPageLayout",
                    "layoutAssignmentTitle":null,
                    "layoutViewports":"",
                    "collectionId":"cat90042"
                },
                "defaultPage":true,
                "pageType":"category",
                "route":"/category",
                "pageTypeId":"categoryPageType",
                "displayName":"Collection",
                "name":"category",
                "repositoryId":"categoryPage"
            }
        ],
        "displayName":"Collection",
        "shortName":"category"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "layoutProductTypes":"",
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"product",
                    "productId":"xprod2535",
                    "layoutPreviewTitle":null,
                    "displayName":"Product Layout",
                    "repositoryId":"prodPageLayout",
                    "layoutAssignmentTitle":null,
                    "layoutViewports":"",
                    "layoutProducts":""
                },
                "defaultPage":true,
                "pageType":"product",
                "route":"/product",
                "pageTypeId":"productPageType",
                "displayName":"Product",
                "name":"product",
                "repositoryId":"productPage"
            }
        ],
        "displayName":"Product",
        "shortName":"product"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "cartPreviewTitle":null,
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"cart",
                    "pageTitle":"",
                    "displayName":"Cart Layout",
                    "repositoryId":"shoppingCartSummaryPageLayout",
                    "skuIds":[
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        }
                    ]
                },
                "defaultPage":true,
                "pageType":"cart",
                "route":"/cart",
                "pageTypeId":"shoppingCartSummaryPageType",
                "displayName":"Cart",
                "name":"cart",
                "repositoryId":"shoppingCartSummaryPage"
            }
        ],
        "displayName":"Cart",
        "shortName":"cart"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "cartPreviewTitle":null,
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"checkout",
                    "pageTitle":"",
                    "displayName":"Checkout Layout",
                    "repositoryId":"checkoutPageLayout",
                    "skuIds":[
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        }
                    ]
                },
                "defaultPage":true,
                "pageType":"checkout",
                "route":"/checkout",
                "pageTypeId":"checkoutPageType",
                "displayName":"Checkout",
                "name":"checkout",
                "repositoryId":"checkoutPage"
            }
        ],
        "displayName":"Checkout",
        "shortName":"checkout"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "cartPreviewTitle":null,
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"confirmation",
                    "pageTitle":"",
                    "displayName":"Order Confirmation Layout",
                    "repositoryId":"checkoutConfirmationPageLayout",
                    "skuIds":[
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        },
                        {
                            "quantity":"",
                            "productId":""
                        }
                    ]
                },
                "defaultPage":true,
                "pageType":"confirmation",
                "route":"/confirmation",
                "pageTypeId":"checkoutConfirmationPageType",
                "displayName":"Confirmation",
                "name":"confirmation",
                "repositoryId":"checkoutConfirmationPage"
            }
        ],
        "displayName":"Order Confirmation",
        "shortName":"confirmation"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"aboutUs",
                    "displayName":"About Us Layout",
                    "repositoryId":"aboutUsPageLayout"
                },
                "defaultPage":true,
                "pageType":"article",
                "route":"/aboutUs",
                "pageTypeId":"articlePageType",
                "displayName":"About Us",
                "name":"aboutUs",
                "repositoryId":"aboutUsPage"
            },
            {
                "layout":{
                    "defaultPage":false,
                    "notes":null,
                    "pageAddress":"contactUs",
                    "displayName":"Contact Us Layout",
                    "repositoryId":"contactUsPageLayout"
                },
                "defaultPage":false,
                "pageType":"article",
                "route":"/contactUs",
                "pageTypeId":"articlePageType",
                "displayName":"Contact Us",
                "name":"contactUs",
                "repositoryId":"contactUsPage"
            },
            {
                "layout":{
                    "defaultPage":false,
                    "notes":null,
                    "pageAddress":"privacy",
                    "displayName":"Privacy Layout",
                    "repositoryId":"privacyPageLayout"
                },
                "defaultPage":false,
                "pageType":"article",
                "route":"/privacy",
                "pageTypeId":"articlePageType",
                "displayName":"Privacy",
                "name":"privacy",
                "repositoryId":"privacyPage"
            },
            {
                "layout":{
                    "defaultPage":false,
                    "notes":null,
                    "pageAddress":"returns",
                    "displayName":"Returns Layout",
                    "repositoryId":"returnsPageLayout"
                },
                "defaultPage":false,
                "pageType":"article",
                "route":"/returns",
                "pageTypeId":"articlePageType",
                "displayName":"Returns",
                "name":"returns",
                "repositoryId":"returnsPage"
            },
            {
                "layout":{
                    "defaultPage":false,
                    "notes":null,
                    "pageAddress":"shipping",
                    "displayName":"Shipping Layout",
                    "repositoryId":"shippingPageLayout"
                },
                "defaultPage":false,
                "pageType":"article",
                "route":"/shipping",
                "pageTypeId":"articlePageType",
                "displayName":"Shipping",
                "name":"shipping",
                "repositoryId":"shippingPage"
            }
        ],
        "displayName":"Article",
        "shortName":"article"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"404",
                    "displayName":"Error Layout",
                    "pageTitle":"",
                    "repositoryId":"404PageLayout"
                },
                "defaultPage":true,
                "pageType":"error",
                "route":"/404",
                "pageTypeId":"errorPageType",
                "displayName":"Page Not Found",
                "name":"404",
                "repositoryId":"404page"
            }
        ],
        "displayName":"Error",
        "shortName":"error"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"searchresults",
                    "displayName":"Search Results Layout",
                    "repositoryId":"searchResultsPageLayout"
                },
                "defaultPage":true,
                "pageType":"searchResults",
                "route":"/searchresults",
                "pageTypeId":"searchResultsPageType",
                "displayName":"Search Results",
                "name":"searchresults",
                "repositoryId":"searchResultsPage"
            }
        ],
        "displayName":"Search Results",
        "shortName":"searchResults"
    },
    {
        "pageLayouts":[
            {
                "layout":{
                    "defaultPage":true,
                    "notes":null,
                    "pageAddress":"noSearchResults",
                    "displayName":"No Search Results Layout",
                    "repositoryId":"noSearchResultsPageLayout"
                },
                "defaultPage":true,
                "pageType":"noSearchResults",
                "route":"/noSearchResults",
                "pageTypeId":"noSearchResultsPageType",
                "displayName":"No Search Results",
                "name":"noSearchResults",
                "repositoryId":"noSearchResultsPage"
            }
        ],
        "displayName":"No Search Results",
        "shortName":"noSearchResults"
    }
]

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| |------------------|------------------| |32001|Error retrieving the layout by its ID.| |20032|No product id specified on item| |20030|internalError|
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