listLayouts
get
/ccadmin/v1/layouts
List Layouts. List all the layouts.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listLayouts_response
Type:
Show Source
object-
items(optional):
array items
Array of objects.
Nested Schema : items
Type:
Show Source
object-
displayName(optional):
string
Display name of the layout.
-
pageLayout(optional):
array pageLayout
Displays page Layout
-
shortName(optional):
string
Short name of display.
Nested Schema : items
Type:
Show Source
object-
defaultPage(optional):
boolean
Display default page or not.
-
displayName(optional):
string
Display name of the page.
-
layout(optional):
object layout
Layout with Dynamic Properties.
-
name(optional):
string
name of the page
-
pageType(optional):
string
Page type of the layout.
-
pageTypeId(optional):
string
ID of page type of the layout
-
repositoryId(optional):
string
repository id of the page.
-
route(optional):
string
Route of Layout
Nested Schema : layout
Type:
objectLayout with Dynamic Properties.
Show Source
-
defaultPage(optional):
boolean
Default Page
-
displayName(optional):
string
Display Name
-
metaTags(optional):
string
Meta Tags
-
notes(optional):
string
Notes
-
pageAddress(optional):
string
Page Address
-
pageTitle(optional):
string
Page Title
-
repositoryId(optional):
string
Repository ID
-
seoMetadataLayoutPreviewTitle(optional):
string
Meta Data Layout Preview Title
-
seoMetaDescription(optional):
string
SEO Meta Description
-
seoMetaKeywords(optional):
string
SEO Meta Keywords
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|
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code