XM
Members
Retrieve Page by URL and Channel ID
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 and channel ID.
Path:
1
GET https://{baseurl}/api-xpm/v2/page/live
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 and the channel ID.
Required: true

Sample Request

1
GET https://{baseurl}/api-xpm//v2/page/live?channelId=12&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: 39 for page: /home.",
4
"data": {
5
"page": {
6
"_id": "6053609551ad48f797a786e8",
7
"name": "Homepage",
8
"pageUrl": "/home",
9
"__v": 0,
10
"createdAt": "2021-03-18T14:15:49.410Z",
11
"isActive": true,
12
"isArchived": false,
13
"pageId": 106,
14
"seoFields": {
15
"title": "Knowledge Base Homepage",
16
"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.",
17
"_id": "60897c9d892fa80008fb8fea",
18
"metadata": [
19
{
20
"_id": "60897c9d892fa80008fb8feb",
21
"name": "canonical",
22
"content": "https://docs.fabric.inc/",
23
"updatedAt": "2021-04-28T15:17:49.027Z",
24
"createdAt": "2021-04-28T15:17:49.027Z"
25
}
26
],
27
"updatedAt": "2021-04-28T15:17:49.027Z",
28
"createdAt": "2021-04-28T15:17:49.027Z"
29
},
30
"updatedAt": "2021-04-30T18:21:38.022Z",
31
"pageType": {
32
"isDefault": false,
33
"name": "Homepage",
34
"urlPrefix": "/home"
35
}
36
},
37
"version": [
38
{
39
"_id": "60802b257900a3000905e4d0",
40
"isArchived": false,
41
"channel": [
42
12
43
],
44
"status": "SCHEDULED",
45
"endDate": "2099-12-31T00:00:00.000Z",
46
"pageId": "6053609551ad48f797a786e8",
47
"name": "Production v1",
48
"description": "Version to go live w/o 5/3/2021",
49
"components": [
50
{
51
"_id": "605ddce3068a620007becbb9",
52
"id": "Title",
53
"key": "WbTGHq7y_4POZonUZFk0L",
54
"params": {
55
"title": "Knowledge Base",
56
"subtitle": "Explore our products and headless commerce solutions",
57
"components": []
58
},
59
"order": 1
60
},
61
{
62
"_id": "605de5dda877e000083bc851",
63
"id": "Showcase",
64
"key": "j0NC8pWwBsRZr8yR1tdK3",
65
"params": {
66
"items": [
67
{
68
"title": "Enterprise Commerce",
69
"description": "Modernize your legacy enterprise platform with headless commerce",
70
"blockColor": "blue",
71
"blockCustomColor": "#e3e5e9",
72
"linkText": "Learn more",
73
"linkUrl": "/start/enterprise-commerce",
74
"components": [],
75
"image": {
76
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.1EnterpriseCommerce.png?auto=compress",
77
"altText": ""
78
}
79
},
80
{
81
"title": "Venture Commerce",
82
"description": "Remove limitations of SMB commerce platforms with headless commerce",
83
"blockColor": "red",
84
"blockCustomColor": "#e3e5e9",
85
"linkText": "Learn more",
86
"linkUrl": "/start/venture-commerce",
87
"components": [],
88
"image": {
89
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.2VentureCommerce.png?auto=compress",
90
"altText": ""
91
}
92
},
93
{
94
"title": "Integrated Commerce",
95
"description": "Have Fabric design a headless commerce solution and grow your business",
96
"blockColor": "green",
97
"blockCustomColor": "#e3e5e9",
98
"linkText": "Learn more",
99
"linkUrl": "/start/integrated-commerce",
100
"components": [],
101
"image": {
102
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/1.3ic_newimage.png?auto=compress",
103
"altText": ""
104
}
105
}
106
],
107
"components": []
108
},
109
"order": 2
110
},
111
{
112
"_id": "6062006de2d9cc0007a8eb58",
113
"id": "Cards",
114
"key": "711_CkbiwHgCvuka-J-mM",
115
"params": {
116
"title": "Get started with Fabric",
117
"items": [
118
{
119
"title": "What Is Fabric?",
120
"subtitle": "Learn about our product suite and vision.",
121
"url": "/start/what-is-fabric",
122
"components": [],
123
"image": {
124
"url": "",
125
"altText": ""
126
}
127
},
128
{
129
"title": "Who Uses Fabric?",
130
"subtitle": "See which types of businesses use Fabric.",
131
"url": "/start/who-uses-fabric",
132
"components": [],
133
"image": {
134
"url": "",
135
"altText": ""
136
}
137
},
138
{
139
"title": "Headless Commerce",
140
"subtitle": "What is headless commerce? Learn more here.",
141
"url": "/start/headless-commerce",
142
"components": [],
143
"image": {
144
"url": "",
145
"altText": ""
146
}
147
},
148
{
149
"title": "Security at Fabric",
150
"subtitle": "Learn how we secure data and ensure compliance.",
151
"url": "/start/security-compliance",
152
"components": [],
153
"image": {
154
"url": "",
155
"altText": ""
156
}
157
}
158
],
159
"components": []
160
},
161
"order": 3
162
},
163
{
164
"_id": "605dedd8a8bfec00074dc484",
165
"id": "ListOfLinks",
166
"key": "OJk47_Fqri00kIllcgI9I",
167
"params": {
168
"title": "Migrate to Fabric",
169
"blockColor": "purple",
170
"blockCustomColor": "#737F8F",
171
"textColor": "white",
172
"listOfLinks": [
173
{
174
"title": "Migration Overview",
175
"link": "/start/migrate",
176
"components": []
177
},
178
{
179
"title": "Migrate from Salesforce",
180
"link": "/start/migrate/salesforce-commerce",
181
"components": []
182
},
183
{
184
"title": "Migrate from Magento",
185
"link": "/start/migrate/magento",
186
"components": []
187
},
188
{
189
"title": "Migrate from Oracle ATG",
190
"link": "/start/migrate/oracle-atg",
191
"components": []
192
},
193
{
194
"title": "Migrate from Shopify Plus",
195
"link": "/start/migrate/shopify-plus",
196
"components": []
197
}
198
],
199
"components": []
200
},
201
"order": 4
202
},
203
{
204
"_id": "606345bddbabb8000731e8f9",
205
"id": "Cards",
206
"key": "UR-qCCALiPaXDohjLAz0K",
207
"params": {
208
"title": "Explore our products",
209
"items": [
210
{
211
"title": "PIM",
212
"subtitle": "Import, manage, and enrich data for products",
213
"url": "/pim",
214
"components": [],
215
"image": {
216
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/PIM.jpg?auto=compress",
217
"altText": "PIM logo"
218
}
219
},
220
{
221
"title": "XM",
222
"subtitle": "Design custom experiences across channels",
223
"url": "/xm",
224
"components": [],
225
"image": {
226
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/XM.jpg?auto=compress",
227
"altText": "XM logo"
228
}
229
},
230
{
231
"title": "Offers",
232
"subtitle": "Manage pricing, promos, and coupons",
233
"url": "/offers",
234
"components": [],
235
"image": {
236
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/offers.jpg?auto=compress",
237
"altText": "Offers logo"
238
}
239
},
240
{
241
"title": "Loyalty",
242
"subtitle": "Create loyalty campaigns and manage rewards",
243
"url": "/loyalty",
244
"components": [],
245
"image": {
246
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/Loyalty.jpg?auto=compress",
247
"altText": "Loyalty logo"
248
}
249
},
250
{
251
"title": "Subscriptions",
252
"subtitle": "Manage subscriptions for replenishables",
253
"url": "/subscriptions",
254
"components": [],
255
"image": {
256
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/subscriptions.jpg?auto=compress",
257
"altText": "Subscriptions logo"
258
}
259
},
260
{
261
"title": "OMS",
262
"subtitle": "Manage orders and streamline fulfillments",
263
"url": "/oms",
264
"components": [],
265
"image": {
266
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/OMS.jpg?auto=compress",
267
"altText": "OMS logo"
268
}
269
},
270
{
271
"title": "POS",
272
"subtitle": "Coming Soon",
273
"url": "",
274
"components": [],
275
"image": {
276
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/POS.jpg?auto=compress",
277
"altText": "POS logo"
278
}
279
},
280
{
281
"title": "Storefront",
282
"subtitle": "Coming Soon",
283
"url": "",
284
"components": [],
285
"image": {
286
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/Storefront.jpg?auto=compress",
287
"altText": ""
288
}
289
}
290
],
291
"components": []
292
},
293
"order": 5
294
},
295
{
296
"_id": "6088af4d5e2e3d0008f9b534",
297
"id": "Showcase",
298
"key": "Y1eGpNLYqqlW0FRWKFQSO",
299
"params": {
300
"items": [
301
{
302
"title": "Latest Release",
303
"description": "Copilot has gotten a facelift! The new UI makes it easier to navigate between Fabric applications.",
304
"blockColor": "yellow",
305
"blockCustomColor": "#e3e5e9",
306
"linkText": "Learn more",
307
"linkUrl": "/copilot/release-notes",
308
"components": [],
309
"image": {
310
"url": "https://greatwall-sandbox-sandbox-image.imgix.net/9127276265/xpm/fabric-copilot-login.jpeg?auto=compress",
311
"altText": "Latest release"
312
}
313
}
314
],
315
"components": []
316
},
317
"order": 6
318
}
319
],
320
"versionId": 39,
321
"createdAt": "2021-04-21T13:39:49.807Z",
322
"updatedAt": "2021-04-30T18:21:37.993Z",
323
"__v": 0,
324
"startDate": "2021-04-22T19:55:22.791Z"
325
}
326
]
327
}
328
}
Copied!

Change Log

  • Jun - 2021 (multichannel features)
Last modified 1mo ago
Copy link
Contents
Change Log