Get all pages
get
/ccstore/v1/pages
This call retrieves all pages defined within the application.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getPages_response
Type:
Show Source
object
-
items(optional):
array items
A list of pages along with their details.
Nested Schema : items
Type:
Show Source
object
-
defaultPage(optional):
boolean
Whether the page is the default page for the site.
-
displayName(optional):
string
The display name property of the page.
-
name(optional):
string
The name property of the page.
-
pageType(optional):
string
The page type short name.
-
pageTypeItem(optional):
object pageTypeItem
The page type item
-
repositoryId(optional):
string
The internal ID of the page.
-
route(optional):
string
The route property of the page.
Nested Schema : pageTypeItem
Type:
object
The page type item
Show Source
-
repositoryId(optional):
string
The internal ID of the page type item.
Example Response (application/json)
[
{
"defaultPage":false,
"displayName":"Returns",
"indexable":true,
"sites":[
],
"rules":[
{
"repositoryId":"returnsPageViewportPageRule"
}
],
"source":null,
"pageTypeItem":{
"repositoryId":"articlePageType"
},
"target":100,
"route":"/returns",
"pageType":"article",
"repositoryId":"returnsPage",
"name":"returns",
"supportedDevices":null,
"secured":false
},
{
"defaultPage":false,
"displayName":"Checkout",
"indexable":false,
"sites":[
],
"rules":[
{
"repositoryId":"checkoutCancelSateRule"
}
],
"source":null,
"pageTypeItem":{
"repositoryId":"checkoutPageType"
},
"target":100,
"route":"/checkout",
"pageType":"checkout",
"repositoryId":"checkoutCancelPage",
"name":"checkout",
"supportedDevices":null,
"secured":false
},
{
"defaultPage":false,
"displayName":"Update Password Account Shopper",
"indexable":false,
"sites":[
],
"rules":[
{
"repositoryId":"updatePasswordAccountShoppersPageRule2"
},
{
"repositoryId":"updatePasswordAccountShoppersPageRule"
},
{
"repositoryId":"updatePasswordAccountShoppersPageRule3"
}
],
"source":null,
"pageTypeItem":{
"repositoryId":"profilePageType"
},
"target":101,
"route":"/updatepassword-accountshoppers",
"pageType":"profile",
"repositoryId":"updatePasswordAccountShoppersPage",
"name":"updatepassword-accountshoppers",
"supportedDevices":null,
"secured":false
},
{
"defaultPage":true,
"displayName":"Order Details",
"indexable":false,
"sites":[
],
"rules":[
],
"source":null,
"pageTypeItem":{
"repositoryId":"orderDetailsPageType"
},
"target":100,
"route":"/orderDetails",
"pageType":"orderDetails",
"repositoryId":"orderDetailsPage",
"name":"orderDetails",
"supportedDevices":null,
"secured":false
}
]
Default Response
Returned when the operation is unsuccessful.
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:
array
An 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