XM
Members
Retrieve Page by URL
This documentation is now outdated, please find the latest docs for this endpoint here
Retrieves a specific live page on your e-commerce website, by URL.
Path:
1
GET https://{baseurl}/api-xpm/page/live?url=/home
Copied!

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.
Required: true

Sample Request

1
https://{baseurl}/page/live?url=/home
Copied!

Sample Response

Response Code: 200
Message: OK
Description: You will see this message when the page is successfully retrieved.
1
{
2
"status_code": 200,
3
"message": "Live version: 2919 for page: /garden.",
4
"data": {
5
"page": {
6
"_id": "6025a9cc685fbffa3d18fee6",
7
"name": "Lawn and Garden",
8
"pageUrl": "/garden",
9
"__v": 0,
10
"createdAt": "2021-02-11T22:03:56.716Z",
11
"isActive": true,
12
"isArchived": false,
13
"pageId": 1475,
14
"seoFields": {
15
"title": "Lawn & Garden",
16
"description": "Everything you need for lawn and garden. With mowers, tractors, tools, hoses, and plants you'll find everything you need in our Garden Centres.",
17
"_id": "6025a9ccbe90f3000819e26b",
18
"metadata": [
19
{
20
"_id": "6025a9ccbe90f3000819e26c",
21
"name": "tag",
22
"content": "034b7bea-6cb5-11eb-9439-0242ac130002",
23
"updatedAt": "2021-02-11T22:03:56.716Z",
24
"createdAt": "2021-02-11T22:03:56.716Z"
25
}
26
],
27
"updatedAt": "2021-02-11T22:03:56.716Z",
28
"createdAt": "2021-02-11T22:03:56.716Z"
29
},
30
"updatedAt": "2021-02-11T22:13:09.452Z",
31
"pageType": {
32
"isDefault": false,
33
"name": "Category List",
34
"urlPrefix": "/category"
35
}
36
},
37
"version": [
38
{
39
"_id": "6025a9ccbe90f3000819e26d",
40
"isArchived": false,
41
"channel": [
42
12
43
],
44
"status": "SCHEDULED",
45
"endDate": "2099-12-31T00:00:00.000Z",
46
"pageId": "6025a9cc685fbffa3d18fee6",
47
"name": "Spring",
48
"components": [
49
{
50
"_id": "6025abf507969d00080b8017",
51
"id": "ImageCarousel",
52
"key": "QddKbgyihudbWIfYtGyGK",
53
"params": {
54
"components": [],
55
"title": "Spring is Here!",
56
"description": "It's time to start planting!",
57
"ctaText": "Shop Plants",
58
"cta": [
59
{
60
"components": [],
61
"text": "",
62
"link": ""
63
}
64
],
65
"items": [
66
{
67
"components": [],
68
"image": {
69
"url": "https://images.unsplash.com/photo-1557429287-b2e26467fc2b?ixlib=rb-1.2.1&ixid=MXwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHw%3D&auto=format&fit=crop&w=1567&q=80",
70
"altText": ""
71
},
72
"description": "",
73
"link": ""
74
},
75
{
76
"components": [],
77
"image": {
78
"url": "https://images.unsplash.com/photo-1470755008296-2939845775eb?ixlib=rb-1.2.1&ixid=MXwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHw%3D&auto=format&fit=crop&w=975&q=80",
79
"altText": ""
80
},
81
"description": "",
82
"link": ""
83
}
84
],
85
"small": false
86
},
87
"order": 1
88
},
89
{
90
"_id": "6025abf507969d00080b8018",
91
"id": "RichText",
92
"key": "mZglbldlRFDKXfBC9dxtm",
93
"params": {
94
"components": [],
95
"rich": "<p>Spring brings with it all the excitement and enthuisiasm of a new season as the cold and wet weather fades away. Planting is best done shortly after the thaw and getting an early start is essential to starting your garden off well and preparing for a successful season of blooms.</p>\n"
96
},
97
"order": 2
98
}
99
],
100
"versionId": 2919,
101
"createdAt": "2021-02-11T22:03:56.786Z",
102
"updatedAt": "2021-02-11T22:13:12.657Z",
103
"__v": 0,
104
"startDate": "2021-02-11T22:13:12.631Z"
105
}
106
]
107
}
108
}
Copied!

Change Log

  • Last updated - Oct 2020
Last modified 1mo ago
Copy link
Contents
Change Log