Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getPages_response

Type: object

Show Source

• items: array items
  A list of pages along with their details.

{
    "properties":{
        "items":{
            "description":"A list of pages along with their details.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "defaultPage":{
                        "description":"Whether the page is the default page for the site.",
                        "type":"boolean"
                    },
                    "pageType":{
                        "description":"The page type short name.",
                        "type":"string"
                    },
                    "route":{
                        "description":"The route property of the page.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The display name property of the page.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name property of the page.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The internal ID of the page.",
                        "type":"string"
                    },
                    "pageTypeItem":{
                        "description":"The page type item",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"The internal ID of the page type item.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

A list of pages along with their details.

Show Source

• Array of: object items

{
    "description":"A list of pages along with their details.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "defaultPage":{
                "description":"Whether the page is the default page for the site.",
                "type":"boolean"
            },
            "pageType":{
                "description":"The page type short name.",
                "type":"string"
            },
            "route":{
                "description":"The route property of the page.",
                "type":"string"
            },
            "displayName":{
                "description":"The display name property of the page.",
                "type":"string"
            },
            "name":{
                "description":"The name property of the page.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The internal ID of the page.",
                "type":"string"
            },
            "pageTypeItem":{
                "description":"The page type item",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The internal ID of the page type item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• defaultPage: boolean
  Whether the page is the default page for the site.
• displayName: string
  The display name property of the page.
• name: string
  The name property of the page.
• pageType: string
  The page type short name.
• pageTypeItem: object pageTypeItem
  The page type item
• repositoryId: string
  The internal ID of the page.
• route: string
  The route property of the page.

{
    "type":"object",
    "properties":{
        "defaultPage":{
            "description":"Whether the page is the default page for the site.",
            "type":"boolean"
        },
        "pageType":{
            "description":"The page type short name.",
            "type":"string"
        },
        "route":{
            "description":"The route property of the page.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name property of the page.",
            "type":"string"
        },
        "name":{
            "description":"The name property of the page.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The internal ID of the page.",
            "type":"string"
        },
        "pageTypeItem":{
            "description":"The page type item",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"The internal ID of the page type item.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : pageTypeItem

Type: object

The page type item

Show Source

• repositoryId: string
  The internal ID of the page type item.

{
    "description":"The page type item",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The internal ID of the page type item.",
            "type":"string"
        }
    }
}

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.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top