Retrieve Menu List

Retrieves a list of menus in a tree structure (in JSON), which has the same hierarchical structure as the menu created by the user in the XM Menu editor. The primary use case is to create your website navigation by leveraging Fabric Menu APIs. You may add root and child categories through the intuitive XM UI and integrate with our APIs for dynamic navigation rendering on your e-commerce frontend.
Path:
1
GET https://{baseurl}/api-xpm/menu
Copied!
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
Parameters []
Sample Request
1
https://{baseurl}/api-xpm/menu
Copied!
Response Code: 200 
Message: OK
Description: You will see this message when the details are successfully retrieved.
Sample
1
{
2
    "status_code": 200,
3
    "status": "List of menus",
4
    "data": {
5
        "menus": [
6
            {
7
                "_id": "5ed116e888926600073d115d",
8
                "channel": [
9
                    12
10
                ],
11
                "path": "javascript:void(0)",
12
                "isActive": true,
13
                "name": "ADULTS",
14
                "label": "ADULTS",
15
                "order": 1,
16
                "images": [],
17
                "videos": [],
18
                "params": [
19
                    {
20
                        "_id": "5ed4a8b9df194a000847424f",
21
                        "kind": "",
22
                        "value": ""
23
                    }
24
                ],
25
                "createdAt": "2020-05-29T14:06:32.417Z",
26
                "updatedAt": "2020-08-20T16:56:36.756Z",
27
                "__v": 0,
28
                "children": [
29
                    {
30
                        "_id": "5ef5804d7263400007059504",
31
                        "channel": [
32
                            12
33
                        ],
34
                        "path": "/",
35
                        "isActive": true,
36
                        "name": "Test PROGRAM",
37
                        "label": "Test PROGRAM",
38
                        "parent": "5ed116e888926600073d115d",
39
                        "order": 1,
40
                        "images": [],
41
                        "videos": [],
42
                        "params": [],
43
                        "createdAt": "2020-06-26T04:57:49.961Z",
44
                        "updatedAt": "2020-07-15T11:27:15.598Z",
45
                        "__v": 0
46
                    },
47
                    {
48
                        "_id": "5ef580a67263400007059506",
49
                        "channel": [
50
                            12
51
                        ],
52
                        "path": "/",
53
                        "isActive": true,
54
                        "name": "CREATE YOUR OWN PROGRAM",
55
                        "label": "CREATE YOUR OWN PROGRAM",
56
                        "parent": "5ed116e888926600073d115d",
57
                        "order": 2,
58
                        "images": [],
59
                        "videos": [],
60
                        "params": [],
61
                        "createdAt": "2020-06-26T04:59:18.302Z",
62
                        "updatedAt": "2020-07-15T11:27:15.616Z",
63
                        "__v": 0
64
                    },
65
                    {
66
                        "_id": "5ef58184726340000705950b",
67
                        "channel": [
68
                            12
69
                        ],
70
                        "path": "/",
71
                        "isActive": true,
72
                        "name": "PREBIOTIC",
73
                        "label": "PREBIOTIC",
74
                        "parent": "5ed116e888926600073d115d",
75
                        "order": 3,
76
                        "images": [],
77
                        "videos": [],
78
                        "params": [],
79
                        "createdAt": "2020-06-26T05:03:00.703Z",
80
                        "updatedAt": "2020-07-15T11:27:15.622Z",
81
                        "__v": 0
82
                    }
83
                ]
84
            },
85
            {
86
                "_id": "5ed1173688926600073d1163",
87
                "channel": [
88
                    12
89
                ],
90
                "path": "/collections/testpro-prebiotic-probiotics-for-baby-and-kids",
91
                "isActive": true,
92
                "name": "KIDS",
93
                "label": "KIDS",
94
                "order": 2,
95
                "images": [],
96
                "videos": [],
97
                "params": [
98
                    {
99
                        "_id": "5ed4a911df194a0008474251",
100
                        "kind": "",
101
                        "value": ""
102
                    }
103
                ],
104
                "createdAt": "2020-05-29T14:07:50.997Z",
105
                "updatedAt": "2020-08-20T16:56:36.768Z",
106
                "__v": 0,
107
                "children": [
108
                    {
109
                        "_id": "5ef581cf726340000705950d",
110
                        "channel": [
111
                            12
112
                        ],
113
                        "path": "/collections/testpro-prebiotic-probiotics-for-baby-and-kids",
114
                        "isActive": true,
115
                        "name": "PREBIOTIC & PROBIOTIC",
116
                        "label": "PREBIOTIC & PROBIOTIC",
117
                        "parent": "5ed1173688926600073d1163",
118
                        "order": 1,
119
                        "images": [],
120
                        "videos": [],
121
                        "params": [
122
                            {
123
                                "_id": "5ef581dfb23cd100088cf4ec",
124
                                "kind": "",
125
                                "value": ""
126
                            }
127
                        ],
128
                        "createdAt": "2020-06-26T05:04:15.057Z",
129
                        "updatedAt": "2020-06-26T05:06:54.561Z",
130
                        "__v": 0
131
                    },
132
                    {
133
                        "_id": "5ef5822c7263400007059510",
134
                        "channel": [
135
                            12
136
                        ],
137
                        "path": "/pages/testpro-product-ingredients",
138
                        "isActive": true,
139
                        "name": "Ingredient Info",
140
                        "label": "Ingredient Info",
141
                        "parent": "5ed1173688926600073d1163",
142
                        "order": 2,
143
                        "images": [],
144
                        "videos": [],
145
                        "params": [
146
                            {
147
                                "_id": "5ef58235b23cd100088cf4ef",
148
                                "kind": "",
149
                                "value": ""
150
                            }
151
                        ],
152
                        "createdAt": "2020-06-26T05:05:48.198Z",
153
                        "updatedAt": "2020-06-26T05:06:57.533Z",
154
                        "__v": 0
155
                    },
156
                    {
157
                        "_id": "5ef5824d7263400007059511",
158
                        "channel": [
159
                            12
160
                        ],
161
                        "path": "/",
162
                        "isActive": true,
163
                        "name": "FAQs",
164
                        "label": "FAQs",
165
                        "parent": "5ed1173688926600073d1163",
166
                        "order": 3,
167
                        "images": [],
168
                        "videos": [],
169
                        "params": [],
170
                        "createdAt": "2020-06-26T05:06:21.026Z",
171
                        "updatedAt": "2020-06-26T05:06:59.954Z",
172
                        "__v": 0
173
                    },
174
                    {
175
                        "_id": "5ef5825d7263400007059512",
176
                        "channel": [
177
                            12
178
                        ],
179
                        "path": "/pages/why-testpro-baby-kids-probiotics",
180
                        "isActive": true,
181
                        "name": "Why Testpro",
182
                        "label": "Why Testpro",
183
                        "parent": "5ed1173688926600073d1163",
184
                        "order": 4,
185
                        "images": [],
186
                        "videos": [],
187
                        "params": [
188
                            {
189
                                "_id": "5ef5826ab23cd100088cf4f0",
190
                                "kind": "",
191
                                "value": ""
192
                            }
193
                        ],
194
                        "createdAt": "2020-06-26T05:06:37.304Z",
195
                        "updatedAt": "2020-06-26T05:07:03.119Z",
196
                        "__v": 0
197
                    }
198
                ]
199
            },
200
            {
201
                "_id": "5ed1187988926600073d1166",
202
                "channel": [
203
                    12
204
                ],
205
                "path": "javascript:void(0)",
206
                "isActive": true,
207
                "name": "LEARN",
208
                "label": "LEARN",
209
                "order": 3,
210
                "images": [],
211
                "videos": [],
212
                "params": [
213
                    {
214
                        "_id": "5ed4a8f6df194a0008474250",
215
                        "kind": "",
216
                        "value": ""
217
                    }
218
                ],
219
                "createdAt": "2020-05-29T14:13:13.002Z",
220
                "updatedAt": "2020-08-20T16:56:36.781Z",
221
                "__v": 0,
222
                "children": [
223
                    {
224
                        "_id": "5ed118c188926600073d1169",
225
                        "channel": [
226
                            12
227
                        ],
228
                        "path": "/pages/gut-guide",
229
                        "isActive": true,
230
                        "name": "GUT GUIDE",
231
                        "label": "GUT GUIDE",
232
                        "parent": "5ed1187988926600073d1166",
233
                        "order": 3,
234
                        "images": [],
235
                        "videos": [],
236
                        "params": [
237
                            {
238
                                "_id": "5ed4aaa6df194a000847425c",
239
                                "kind": "",
240
                                "value": ""
241
                            }
242
                        ],
243
                        "createdAt": "2020-05-29T14:14:25.857Z",
244
                        "updatedAt": "2020-08-19T14:29:31.550Z",
245
                        "__v": 0
246
                    },
247
                    {
248
                        "_id": "5ef583457263400007059516",
249
                        "channel": [
250
                            12
251
                        ],
252
                        "path": "/pages/about-us",
253
                        "isActive": true,
254
                        "name": "Our Story",
255
                        "label": "Our Story",
256
                        "parent": "5ed1187988926600073d1166",
257
                        "order": 2,
258
                        "images": [],
259
                        "videos": [],
260
                        "params": [
261
                            {
262
                                "_id": "5ef5834cb23cd100088cf4f6",
263
                                "kind": "",
264
                                "value": ""
265
                            }
266
                        ],
267
                        "createdAt": "2020-06-26T05:10:29.214Z",
268
                        "updatedAt": "2020-08-19T14:29:31.552Z",
269
                        "__v": 0
270
                    },
271
                    {
272
                        "_id": "5ef583557263400007059517",
273
                        "channel": [
274
                            12
275
                        ],
276
                        "path": "/pages/press",
277
                        "isActive": true,
278
                        "name": "Press",
279
                        "label": "Press",
280
                        "parent": "5ed1187988926600073d1166",
281
                        "order": 3,
282
                        "images": [],
283
                        "videos": [],
284
                        "params": [
285
                            {
286
                                "_id": "5ef5835cb23cd100088cf4f7",
287
                                "kind": "",
288
                                "value": ""
289
                            }
290
                        ],
291
                        "createdAt": "2020-06-26T05:10:45.567Z",
292
                        "updatedAt": "2020-08-19T14:29:31.567Z",
293
                        "__v": 0
294
                    },
295
                    {
296
                        "_id": "5ef5837a7263400007059518",
297
                        "channel": [
298
                            12
299
                        ],
300
                        "path": "/blogs/the-digest",
301
                        "isActive": true,
302
                        "name": "Blog - The Digest",
303
                        "label": "Blog - The Digest",
304
                        "parent": "5ed1187988926600073d1166",
305
                        "order": 4,
306
                        "images": [],
307
                        "videos": [],
308
                        "params": [
309
                            {
310
                                "_id": "5ef58380b23cd100088cf4f8",
311
                                "kind": "",
312
                                "value": ""
313
                            }
314
                        ],
315
                        "createdAt": "2020-06-26T05:11:22.615Z",
316
                        "updatedAt": "2020-08-19T14:29:31.568Z",
317
                        "__v": 0
318
                    },
319
                    {
320
                        "_id": "5ef5838a7263400007059519",
321
                        "channel": [
322
                            12
323
                        ],
324
                        "path": "https://faq.test.com/",
325
                        "isActive": true,
326
                        "name": "FAQs",
327
                        "label": "FAQs",
328
                        "parent": "5ed1187988926600073d1166",
329
                        "order": 5,
330
                        "images": [],
331
                        "videos": [],
332
                        "params": [
333
                            {
334
                                "_id": "5eff2d8f5f2059000778534d",
335
                                "kind": "",
336
                                "value": ""
337
                            }
338
                        ],
339
                        "createdAt": "2020-06-26T05:11:38.981Z",
340
                        "updatedAt": "2020-08-19T14:29:31.570Z",
341
                        "__v": 0
342
                    }
343
                ]
344
            },
345
            {
346
                "_id": "5f27bc9b9be72f00083db446",
347
                "channel": [
348
                    12
349
                ],
350
                "path": "/a1",
351
                "isActive": false,
352
                "name": "a1",
353
                "label": "a1",
354
                "order": 4,
355
                "images": [],
356
                "videos": [],
357
                "params": [
358
                    {
359
                        "_id": "5f3e3cf2bcc65f0007483adb",
360
                        "kind": "",
361
                        "value": ""
362
                    }
363
                ],
364
                "createdAt": "2020-08-03T07:28:27.522Z",
365
                "updatedAt": "2020-08-20T16:56:36.793Z",
366
                "__v": 0,
367
                "children": [
368
                    {
369
                        "_id": "5f27bcac9be72f00083db447",
370
                        "channel": [
371
                            12
372
                        ],
373
                        "path": "/",
374
                        "isActive": false,
375
                        "name": "a2",
376
                        "label": "a2",
377
                        "parent": "5f27bc9b9be72f00083db446",
378
                        "order": 1,
379
                        "images": [],
380
                        "videos": [],
381
                        "params": [],
382
                        "createdAt": "2020-08-03T07:28:44.341Z",
383
                        "updatedAt": "2020-08-11T14:08:46.540Z",
384
                        "__v": 0
385
                    },
386
                    {
387
                        "_id": "5f27bd099be72f00083db448",
388
                        "channel": [
389
                            12
390
                        ],
391
                        "path": "/",
392
                        "isActive": false,
393
                        "name": "a2",
394
                        "label": "a2",
395
                        "parent": "5f27bc9b9be72f00083db446",
396
                        "order": 2,
397
                        "images": [],
398
                        "videos": [],
399
                        "params": [],
400
                        "createdAt": "2020-08-03T07:30:17.258Z",
401
                        "updatedAt": "2020-08-03T07:30:17.258Z",
402
                        "__v": 0
403
                    }
404
                ]
405
            }
406
        ]
407
    }
408
}
Copied!
Change Log
Last updated - Oct 2020
​

Retrieve Live Global Components

Retrieve Menu

Last modified 2mo ago

Copy link

Contents

Change Log