XM

Retrieve Page by URL and Channel ID

Retrieves a specific live page on your e-commerce website, by URL and channel ID.

Path:

GET https://{baseurl}/api-xpm/v2/page/live

Headers

Content-Type : application/json

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : query

Name : The page URL and the channel ID.

Required: true

Sample Request

GET https://{baseurl}/api-xpm//v2/page/live?channelId=12&url=/home

Sample Response

Response Code: 200

Message: OK

Description: You will see this message when the page is successfully retrieved.

{
"status_code": 200,
"message": "Live version: 39 for page: /home.",
"data": {
"page": {
"_id": "6053609551ad48f797a786e8",
"name": "Homepage",
"pageUrl": "/home",
"__v": 0,
"createdAt": "2021-03-18T14:15:49.410Z",
"isActive": true,
"isArchived": false,
"pageId": 106,
"seoFields": {
"title": "Knowledge Base Homepage",
"description": "Welcome to our Knowledge Base! We're continually developing this resource to help you understand our methodology as a modern SaaS company and fully utilize our suite of headless commerce products.",
"_id": "60897c9d892fa80008fb8fea",
"metadata": [
{
"_id": "60897c9d892fa80008fb8feb",
"name": "canonical",
"content": "https://docs.fabric.inc/",
"updatedAt": "2021-04-28T15:17:49.027Z",
"createdAt": "2021-04-28T15:17:49.027Z"
}
],
"updatedAt": "2021-04-28T15:17:49.027Z",
"createdAt": "2021-04-28T15:17:49.027Z"
},
"updatedAt": "2021-04-30T18:21:38.022Z",
"pageType": {
"isDefault": false,
"name": "Homepage",
"urlPrefix": "/home"
}
},
"version": [
{
"_id": "60802b257900a3000905e4d0",
"isArchived": false,
"channel": [
12
],
"status": "SCHEDULED",
"endDate": "2099-12-31T00:00:00.000Z",
"pageId": "6053609551ad48f797a786e8",
"name": "Production v1",
"description": "Version to go live w/o 5/3/2021",
"components": [
{
"_id": "605ddce3068a620007becbb9",
"id": "Title",
"key": "WbTGHq7y_4POZonUZFk0L",
"params": {
"title": "Knowledge Base",
"subtitle": "Explore our products and headless commerce solutions",
"components": []
},
"order": 1
},
{
"_id": "605de5dda877e000083bc851",
"id": "Showcase",
"key": "j0NC8pWwBsRZr8yR1tdK3",
"params": {
"items": [
{
"title": "Enterprise Commerce",
"description": "Modernize your legacy enterprise platform with headless commerce",
"blockColor": "blue",
"blockCustomColor": "#e3e5e9",
"linkText": "Learn more",
"linkUrl": "/start/enterprise-commerce",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.1EnterpriseCommerce.png?auto=compress",
"altText": ""
}
},
{
"title": "Venture Commerce",
"description": "Remove limitations of SMB commerce platforms with headless commerce",
"blockColor": "red",
"blockCustomColor": "#e3e5e9",
"linkText": "Learn more",
"linkUrl": "/start/venture-commerce",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.2VentureCommerce.png?auto=compress",
"altText": ""
}
},
{
"title": "Integrated Commerce",
"description": "Have Fabric design a headless commerce solution and grow your business",
"blockColor": "green",
"blockCustomColor": "#e3e5e9",
"linkText": "Learn more",
"linkUrl": "/start/integrated-commerce",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.3ic_newimage.png?auto=compress",
"altText": ""
}
}
],
"components": []
},
"order": 2
},
{
"_id": "6062006de2d9cc0007a8eb58",
"id": "Cards",
"key": "711_CkbiwHgCvuka-J-mM",
"params": {
"title": "Get started with Fabric",
"items": [
{
"title": "What Is Fabric?",
"subtitle": "Learn about our product suite and vision.",
"url": "/start/what-is-fabric",
"components": [],
"image": {
"url": "",
"altText": ""
}
},
{
"title": "Who Uses Fabric?",
"subtitle": "See which types of businesses use Fabric.",
"url": "/start/who-uses-fabric",
"components": [],
"image": {
"url": "",
"altText": ""
}
},
{
"title": "Headless Commerce",
"subtitle": "What is headless commerce? Learn more here.",
"url": "/start/headless-commerce",
"components": [],
"image": {
"url": "",
"altText": ""
}
},
{
"title": "Security at Fabric",
"subtitle": "Learn how we secure data and ensure compliance.",
"url": "/start/security-compliance",
"components": [],
"image": {
"url": "",
"altText": ""
}
}
],
"components": []
},
"order": 3
},
{
"_id": "605dedd8a8bfec00074dc484",
"id": "ListOfLinks",
"key": "OJk47_Fqri00kIllcgI9I",
"params": {
"title": "Migrate to Fabric",
"blockColor": "purple",
"blockCustomColor": "#737F8F",
"textColor": "white",
"listOfLinks": [
{
"title": "Migration Overview",
"link": "/start/migrate",
"components": []
},
{
"title": "Migrate from Salesforce",
"link": "/start/migrate/salesforce-commerce",
"components": []
},
{
"title": "Migrate from Magento",
"link": "/start/migrate/magento",
"components": []
},
{
"title": "Migrate from Oracle ATG",
"link": "/start/migrate/oracle-atg",
"components": []
},
{
"title": "Migrate from Shopify Plus",
"link": "/start/migrate/shopify-plus",
"components": []
}
],
"components": []
},
"order": 4
},
{
"_id": "606345bddbabb8000731e8f9",
"id": "Cards",
"key": "UR-qCCALiPaXDohjLAz0K",
"params": {
"title": "Explore our products",
"items": [
{
"title": "PIM",
"subtitle": "Import, manage, and enrich data for products",
"url": "/pim",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/PIM.jpg?auto=compress",
"altText": "PIM logo"
}
},
{
"title": "XM",
"subtitle": "Design custom experiences across channels",
"url": "/xm",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/XM.jpg?auto=compress",
"altText": "XM logo"
}
},
{
"title": "Offers",
"subtitle": "Manage pricing, promos, and coupons",
"url": "/offers",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/offers.jpg?auto=compress",
"altText": "Offers logo"
}
},
{
"title": "Loyalty",
"subtitle": "Create loyalty campaigns and manage rewards",
"url": "/loyalty",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/Loyalty.jpg?auto=compress",
"altText": "Loyalty logo"
}
},
{
"title": "Subscriptions",
"subtitle": "Manage subscriptions for replenishables",
"url": "/subscriptions",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/subscriptions.jpg?auto=compress",
"altText": "Subscriptions logo"
}
},
{
"title": "OMS",
"subtitle": "Manage orders and streamline fulfillments",
"url": "/oms",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/OMS.jpg?auto=compress",
"altText": "OMS logo"
}
},
{
"title": "POS",
"subtitle": "Coming Soon",
"url": "",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/POS.jpg?auto=compress",
"altText": "POS logo"
}
},
{
"title": "Storefront",
"subtitle": "Coming Soon",
"url": "",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/Storefront.jpg?auto=compress",
"altText": ""
}
}
],
"components": []
},
"order": 5
},
{
"_id": "6088af4d5e2e3d0008f9b534",
"id": "Showcase",
"key": "Y1eGpNLYqqlW0FRWKFQSO",
"params": {
"items": [
{
"title": "Latest Release",
"description": "Copilot has gotten a facelift! The new UI makes it easier to navigate between Fabric applications.",
"blockColor": "yellow",
"blockCustomColor": "#e3e5e9",
"linkText": "Learn more",
"linkUrl": "/copilot/release-notes",
"components": [],
"image": {
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/fabric-copilot-login.jpeg?auto=compress",
"altText": "Latest release"
}
}
],
"components": []
},
"order": 6
}
],
"versionId": 39,
"createdAt": "2021-04-21T13:39:49.807Z",
"updatedAt": "2021-04-30T18:21:37.993Z",
"__v": 0,
"startDate": "2021-04-22T19:55:22.791Z"
}
]
}
}

Change Log

  • Jun - 2021 (multichannel features)