Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Get Live Pages For Specified Channels
Get a list of all the live pages for the specified channels
Number of items to omit before collecting the resulting set
Total number of results
Comma-separated list of channel IDs
{
"message": "List of pages with queryParams {\"channels\":\"02SZCA,00SZAU\",\"offset\":0,\"limit\":20}",
"data": {
"query": {
"limit": 20,
"offset": 0,
"count": 1,
"channels": [
"02SZCA",
"00SZAU"
]
},
"livePages": [
{
"_id": "613a76a1fa9449000f6c36c3",
"isArchived": false,
"name": "Default",
"channel": [
12
],
"channels": [
"00SZAU",
"02SZCA"
],
"createdAt": "2021-09-09T21:03:29.712Z",
"updatedAt": "2021-10-14T20:31:47.369Z",
"components": [
{
"_id": "61689237068cae000f12ef90",
"id": "AboutUs",
"params": {
"desktopHeroImage": {
"url": "https://imgurl.com/path/myPhoto.jpg",
"altText": "Custom image"
},
"aboutUsContent": [
{
"text": "About us",
"firstText": "Our Company",
"secondText": "Our mission",
"thirdText": "Our values",
"paragraph": false,
"dialog": false,
"components": []
}
],
"components": [],
"additionalProp1": {}
},
"order": 1,
"additionalProp1": {}
}
],
"endDate": "2099-12-31T00:00:00.000Z",
"pageId": "613a76a15363f9e9575dc953",
"status": "SCHEDULED",
"versionId": 2446,
"page": {
"_id": "613a76a15363f9e9575dc953",
"name": "Components",
"pageUrl": "/components",
"__v": 0,
"channels": [
"00SZAU",
"02SZCA"
],
"createdAt": "2021-09-09T21:03:29.617Z",
"isActive": true,
"isArchived": false,
"pageId": 1377,
"seoFields": {
"title": "SEO",
"description": "SEO description",
"_id": "612e4756c4b3c60010fff859",
"metadata": [
{
"_id": "612e4756c4b3c60010fff85a",
"name": "summary",
"content": "Types of components",
"createdAt": "2021-08-31T15:14:30.973Z",
"updatedAt": "2021-08-31T15:14:30.973Z"
}
],
"createdAt": "2021-08-31T15:14:30.973Z",
"updatedAt": "2021-08-31T15:14:30.973Z"
},
"typeId": "61325fd059cbdbe62e888bc0",
"updatedAt": "2021-10-14T20:31:46.794Z",
"typeName": "Product category page",
"typeUrl": "/category"
}
}
]
}
}
Query Parameters
Number of items to omit before collecting the resulting set
Total number of results
Comma-separated list of channel IDs
Response
200 response object
Status message
Object holding the query information and the list of live page versions
Array of live page versions
Database ID associated with the version
True = version is archived <br /> false = version is not archived
Deprecated field holding channel information
Channel IDs associated with the version
Current status of the version
Ending timestamp of page. That is Date and time when the version will no longer be live
Database ID of the page associated with the version
Version name
Version description
Version ID
Timestamp of version creation
Timestamp on when version was last updated
Page details
Page name
Relative page URL
Timestamp of page creation
Timestamp of when page was last updated
True = page is active <br /> false = page is not active
True = page is archived <br /> false = page is not archived
Page ID
Channel IDs associated with the page
SEO fields
SEO field name
SEO field description
Timestamp of SEO field creation
Timestamp of when SEO field was last updated
list of metadata associated with the SEO field
Virtual ID associated with the SEO field
Name of the page type
URL associated with page type
Database ID associated with the page
VersionKey associated with the page
deprecated field holding channel information
Database ID for the page type linked to the page
Was this page helpful?
{
"message": "List of pages with queryParams {\"channels\":\"02SZCA,00SZAU\",\"offset\":0,\"limit\":20}",
"data": {
"query": {
"limit": 20,
"offset": 0,
"count": 1,
"channels": [
"02SZCA",
"00SZAU"
]
},
"livePages": [
{
"_id": "613a76a1fa9449000f6c36c3",
"isArchived": false,
"name": "Default",
"channel": [
12
],
"channels": [
"00SZAU",
"02SZCA"
],
"createdAt": "2021-09-09T21:03:29.712Z",
"updatedAt": "2021-10-14T20:31:47.369Z",
"components": [
{
"_id": "61689237068cae000f12ef90",
"id": "AboutUs",
"params": {
"desktopHeroImage": {
"url": "https://imgurl.com/path/myPhoto.jpg",
"altText": "Custom image"
},
"aboutUsContent": [
{
"text": "About us",
"firstText": "Our Company",
"secondText": "Our mission",
"thirdText": "Our values",
"paragraph": false,
"dialog": false,
"components": []
}
],
"components": [],
"additionalProp1": {}
},
"order": 1,
"additionalProp1": {}
}
],
"endDate": "2099-12-31T00:00:00.000Z",
"pageId": "613a76a15363f9e9575dc953",
"status": "SCHEDULED",
"versionId": 2446,
"page": {
"_id": "613a76a15363f9e9575dc953",
"name": "Components",
"pageUrl": "/components",
"__v": 0,
"channels": [
"00SZAU",
"02SZCA"
],
"createdAt": "2021-09-09T21:03:29.617Z",
"isActive": true,
"isArchived": false,
"pageId": 1377,
"seoFields": {
"title": "SEO",
"description": "SEO description",
"_id": "612e4756c4b3c60010fff859",
"metadata": [
{
"_id": "612e4756c4b3c60010fff85a",
"name": "summary",
"content": "Types of components",
"createdAt": "2021-08-31T15:14:30.973Z",
"updatedAt": "2021-08-31T15:14:30.973Z"
}
],
"createdAt": "2021-08-31T15:14:30.973Z",
"updatedAt": "2021-08-31T15:14:30.973Z"
},
"typeId": "61325fd059cbdbe62e888bc0",
"updatedAt": "2021-10-14T20:31:46.794Z",
"typeName": "Product category page",
"typeUrl": "/category"
}
}
]
}
}