XM (2.0.0)

Download OpenAPI specification:Download

E-mail: support@fabric.inc License: fabric Inc

fabric's Experience Manager (XM) enables you to design, implement, and optimize omnichannel e-commerce experiences, without having to code. With XM, you can easily add parent and child categories through our intuitive UI to create your website navigation, and seamlessly integrate with our APIs for dynamic navigation rendering on your store front. In addition, developers can implement agile design by creating reusable design components and use one set of data and APIs for every channel.

Pages

XM Pages API allows you to fetch all the live pages, or a live page by a specific URL

Retrieves Live Pages

Returns a list of all the live pages

Request

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

204

No live pages

404

Tenant not found

500

The request was received but an internal error occurred

get/pages/live

Response samples

application/json

{"status": 200,
"data": {"livePages": [{"_id": "60788b398fad06000899bdc4",
"isArchived": false,
"channel": [12
],
"channels": ["12"
],
"status": "SCHEDULED",
"endDate": "2099-12-31T00:00:00.000Z",
"startDate": "2021-04-16T15:05:12.172Z",
"pageId": "60788b39f59a96c12ce27460",
"name": "KO v1",
"components": [{"_id": "6079db97f395c800086a1ceb",
"id": "Title",
"params": {"title": "FAQ",
"subtitle": "Questions you may have around our commerce apps, getting started, security and compliance\"",
"components": [ ],
"additionalProp1": { }
},
"order": 1,
"additionalProp1": { }
},
{"_id": "6079db97f395c800086a1cec",
"id": "PopularQuestions",
"params": {"title": "POPULAR TOPICS",
"questions": [{"title": "Getting started",
"body": "Question 1",
"linkText": "Click here to view",
"linkUrl": "https://fabric.inc/"
}
],
"components": [ ],
"additionalProp1": { }
},
"order": 2,
"additionalProp1": { }
}
],
"versionId": 36,
"createdAt": "2021-04-15T18:51:37.475Z",
"updatedAt": "2021-04-26T16:40:24.212Z",
"__v": 0,
"page": {"_id": "60788b39f59a96c12ce27460",
"name": "Popular FAQs",
"pageUrl": "/faq",
"__v": 0,
"channels": ["12"
],
"createdAt": "2021-04-15T18:51:37.416Z",
"isActive": true,
"isArchived": false,
"pageId": 114,
"typeId": "60788b0bf59a96c12ce27214",
"updatedAt": "2021-04-26T16:40:24.253Z"
}
}
]
},
"code": "Ok",
"message": "List of Live Pages",
"service": "toby",
"status_code": 200,
"statusCode": 200
}

Retrieves Live Page By URL

Returns the live page for the specified page url

Request

query Parameters

url

required

string

The relative page url for which to retrieve the live page version

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

204

Page is not live or is inactive

400

Page url not specified

404

Page not found

500

The request was received but an internal error occurred

get/page/live

Response samples

application/json

{"status_code": 200,
"message": "Live version: 39 for page: /home.",
"data": {"page": {"_id": "6053609551ad48f797a786e8",
"name": "Homepage",
"pageUrl": "/home",
"__v": 0,
"channels": ["12"
],
"createdAt": "2021-03-18T14:15:49.410Z",
"isActive": true,
"isArchived": false,
"pageId": 106,
"seoFields": {"title": "Knowledge Base Homepage",
"description": "Welcome to our Knowledge Base!",
"_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
],
"channels": ["12"
],
"status": "SCHEDULED",
"endDate": "2099-12-31T00:00:00.000Z",
"pageId": "6053609551ad48f797a786e8",
"name": "Default v1",
"description": "Default homepage",
"components": [{"_id": "605ddce3068a620007becbb9",
"id": "Title",
"params": {"title": "Knowledge Base",
"subtitle": "Explore our products and headless commerce solutions",
"components": [ ],
"additionalProp1": { }
},
"order": 1,
"additionalProp1": { }
},
{"_id": "605de5dda877e000083bc851",
"id": "Showcase",
"params": {"items": [{"title": "Enterprise commerce",
"blockColor": "blue",
"blockCustomColor": "#e3e5e9",
"linkText": "Learn more",
"linkUrl": "/start/enterprise-commerce",
"components": [ ],
"additionalProp1": { }
}
]
},
"order": 2,
"additionalProp1": { }
}
],
"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"
}
]
}
}

Retrieves Live Pages For Specified Channels

Returns a list of all the live pages for the specified channels

Request

query Parameters

offset	integer Default: 0 The number of items to omit before collecting the resulting set
limit	integer Default: 20 The total number of results to return
channels	string Default: "12" A comma-separated list of channel ids

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

404

The request was received but no data matches the request parameters

500

The request was received but an internal error occurred.

get/v2/pages/live

Response samples

application/json

{"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"
}
}
]
}
}

Retrieves Live Page For A Channel By URL

Returns the live page for the specified page url and channel

Request

query Parameters

url required	string The relative page url for which to retrieve the live page version
channel	string Default: "12" The channel id

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

204

Page is not live or is inactive

400

Page url not specified

404

Page not found

500

The request was received but an internal error occurred

get/v2/page/live

Response samples

application/json

{"status_code": 200,
"message": "Live version: 2446 for page: /components",
"data": {"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"
},
"updatedAt": "2021-10-14T20:31:46.794Z",
"pageType": {"isDefault": false,
"name": "Product category page",
"urlPrefix": "/category"
}
},
"version": [{"_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,
"__v": 0,
"startDate": "2021-10-14T20:31:44.052Z"
}
]
}
}

Global Components

XM Global Components API allows you to fetch all the live global component data

Retrieves Live Global Components

Returns a list of all the live global component data

Request

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

500

The request was received but an internal error occurred

get/global-component/live

Response samples

application/json

[{"_id": "60896f629aa7f1000744030b",
"id": "RailNavigation",
"params": {"homeLinkText": "Home",
"sections": [{"sectionTitle": "Get Started",
"sectionLink": "/start",
"subsections": [{"subSectionTitle": "What is fabric?",
"subSectionLink": "/what-is-fabric",
"components": [ ]
}
],
"components": [ ]
}
],
"title": "Title"
},
"order": 1
},
{"_id": "608ad8760536ac00074bec45",
"id": "CustomHeader",
"params": {"developerSectionText": "developerSectionText",
"developerSectionLinks": [{"title": "Knowledge Base",
"description": "Get started",
"link": "https://fabric.inc/knowledgebase",
"components": [ ]
},
{"title": "API documentation",
"description": "Customize without limits",
"link": "https://api.fabric.inc/",
"components": [ ]
}
]
},
"order": 1
}
]

Retrieves Live Global Components For A Channel

Returns a list of all the live global component data for a specified channel

Request

query Parameters

channel

string

Default: "12"

The channel id for which to retrieve the live global components

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

500

The request was received but an internal error occurred

get/v2/global-component/live

Response samples

application/json

[{"_id": "60896f629aa7f1000744030b",
"id": "RailNavigation",
"params": {"homeLinkText": "Home",
"sections": [{"sectionTitle": "Get Started",
"sectionLink": "/start",
"subsections": [{"subSectionTitle": "What is fabric?",
"subSectionLink": "/what-is-fabric",
"components": [ ]
}
],
"components": [ ]
}
],
"title": "Title"
},
"order": 1
},
{"_id": "608ad8760536ac00074bec45",
"id": "CustomHeader",
"params": {"developerSectionText": "developerSectionText",
"developerSectionLinks": [{"title": "Knowledge Base",
"description": "Get started",
"link": "https://fabric.inc/knowledgebase",
"components": [ ]
},
{"title": "API documentation",
"description": "Customize without limits",
"link": "https://api.fabric.inc/",
"components": [ ]
}
]
},
"order": 1
}
]

Retrieves Menu List

Returns a list of all the menus and its immediate sub-menus

Request

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

500

The request was received but an internal error occurred

get/menu

Response samples

application/json

{"status_code": 200,
"status": "List of menus",
"data": {"menus": [{"_id": "61110b8d3e136500082f5d42",
"channel": [12
],
"channels": [ ],
"name": "Gifts + Holiday",
"label": "Gifts + Holiday",
"path": "/c/gifts",
"isActive": true,
"images": [ ],
"videos": [ ],
"params": [{"_id": "61110bba873a390008d3a2fe",
"kind": "context",
"value": "gifts"
}
],
"order": 1,
"createdAt": "2021-08-09T11:03:41.984Z",
"updatedAt": "2021-10-05T17:28:39.582Z",
"__v": 0,
"children": [{"_id": "61110bcb3e136500082f5d48",
"channel": [12
],
"channels": [ ],
"name": "Gifts by Price",
"label": "Gifts by Price",
"parent": "61110b8d3e136500082f5d42",
"path": "/c/gifts/gifts-by-price",
"isActive": true,
"images": [ ],
"videos": [ ],
"params": [{"_id": "61110bdd873a390008d3a303",
"kind": "context",
"value": "gifts_gifts-by-price"
}
],
"order": 1,
"createdAt": "2021-08-09T11:04:43.526Z",
"updatedAt": "2021-08-09T11:11:57.833Z",
"__v": 0
}
]
},
{"_id": "61138c153f658a00085e2eba",
"channel": [12
],
"channels": [ ],
"name": "Bedroom",
"label": "Bedroom",
"path": "/",
"isActive": false,
"images": [ ],
"videos": [ ],
"params": [ ],
"order": 2,
"createdAt": "2021-08-11T08:36:37.823Z",
"updatedAt": "2021-10-05T17:28:39.650Z",
"__v": 0,
"children": [ ]
}
]
}
}

Retrieves All Menu Items

Returns a list of all active menus all their menu items

Request

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

404

Menu not found

500

The request was received but an internal error occurred

get/menu/items

Response samples

application/json

{"status_code": 200,
"status": "List of active menus",
"data": {"MenuList": [{"id": "61110b8d3e136500082f5d42",
"label": "Gifts + Holiday",
"order": 1,
"isActive": true,
"channel": [12
],
"path": "/c/gifts",
"params": [{"_id": "61110bba873a390008d3a2fe",
"kind": "context",
"value": "gifts"
}
],
"children": [{"id": "61110bcb3e136500082f5d48",
"label": "Gifts by Price",
"order": 1,
"isActive": true,
"channel": [12
],
"path": "/c/gifts/gifts-by-price",
"params": [{"_id": "61110bdd873a390008d3a303",
"kind": "context",
"value": "gifts_gifts-by-price"
}
],
"children": [{"id": "61110bf93e136500082f5d4d",
"label": "Gifts Under $250",
"order": 1,
"isActive": true,
"channel": [12
],
"path": "/c/gifts/gifts-by-price/gifts-under-250",
"params": [{"kind": "context",
"value": "gifts_gifts-by-price_gifts-under-250"
}
],
"children": [ ]
},
{"id": "61110c1a3e136500082f5d52",
"label": "Gifts Under $500",
"order": 2,
"isActive": false,
"channel": [12
],
"path": "/c/gifts/gifts-by-price/gifts-under-500",
"params": [{"kind": "context",
"value": "gifts_gifts-by-price_gifts-under-500"
}
],
"children": [ ]
}
]
},
{"id": "61110c3e3e136500082f5d56",
"label": "Dining + Entertainment",
"order": 3,
"isActive": true,
"channel": [12
],
"path": "/",
"params": [ ],
"children": [{"id": "61110c513e136500082f5d5b",
"label": "All Dining + Entertainment",
"order": 1,
"isActive": true,
"channel": [12
],
"path": "/content/shop/dining-entertaining",
"params": [{"kind": "",
"value": ""
}
],
"children": [ ]
}
]
}
]
}
]
}
}

Retrieves Menu Item By URL

Returns the menu item corresponding to the specified URL

Request

query Parameters

url	string The menu item url path

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

400

Menu item url path not specified

404

Menu not found

500

The request was received but an internal error occurred

get/menu/get-item-by-url

Response samples

application/json

{"status_code": 200,
"status": "menu for url /c/gifts/gifts-by-price/gifts-under-250",
"data": {"id": "61110bf93e136500082f5d4d",
"parents": [{"label": "Gifts + Holiday",
"path": "/c/gifts"
},
{"label": "Gifts by Price",
"path": "/c/gifts/gifts-by-price"
}
],
"label": "Gifts Under $250",
"path": "/c/gifts/gifts-by-price/gifts-under-250",
"params": [{"kind": "context",
"value": "gifts_gifts-by-price_gifts-under-250"
}
]
}
}

Retrieves Live Menu For A Channel

Returns the live menu of the specified channel along with all its menu items

Request

query Parameters

nodeId	string The id for a specific menu item, associated with a live menu, to retrieve
parentId	string The id for a parent menu item, associated with a live menu, for which to retrieve the sub-menu items for
depth	integer The depth to traverse when returning menu items
channelId	string Default: "12" The channel id for which to retrieve the live menu

header Parameters

object

The x-site-context is a JSON object that must contain account, stage, and channel attributes. This header can also be called X-Site-Context based on your stylistic preferences.

Responses

200

Successful operation

404

Menu not found

500

The request was received but an internal error occurred

get/v2/menu/live

Response samples

application/json

{"query": {"channelId": "02SZCA"
},
"menu": {"name": "Default",
"channels": ["02SZCA"
],
"children": [{"url": "/books",
"name": "Books",
"order": 0,
"images": [ ],
"nodeId": "6171d995bfdcf11c02a6177f",
"parentId": "6171d977bfdcf11c02a61771",
"children": [{"url": "/books/mystery",
"name": "Mystery",
"order": 0,
"nodeId": "6171d9ecbfdcf11c02a617a7",
"parentId": "6171d995bfdcf11c02a6177f"
},
{"url": "/books/sci-fi",
"name": "Sci-fi",
"order": 1,
"nodeId": "6171d9f2bfdcf11c02a617ac",
"parentId": "6171d995bfdcf11c02a6177f"
},
{"url": "/books/education",
"name": "Education",
"order": 2,
"nodeId": "6171da2fbfdcf11c02a617ba",
"parentId": "6171d995bfdcf11c02a6177f"
}
]
},
{"url": "/health-household",
"name": "Health & Household",
"order": 1,
"images": [{"_id": "6171db97bfdcf11c02a6181c",
"order": 1,
"url": "https://imageUrl.com/myImage.jpg",
"meta": "Custom image"
}
],
"params": [{"_id": "6171db97bfdcf11c02a6181d",
"kind": "Category",
"value": "Health & Household"
}
],
"nodeId": "6171d9b9bfdcf11c02a61791",
"parentId": "6171d977bfdcf11c02a61771",
"children": [{"url": "/health-household/household-supplies",
"name": "Household Supplies",
"order": 0,
"nodeId": "6171da4fbfdcf11c02a617ca",
"parentId": "6171d9b9bfdcf11c02a61791"
},
{"url": "/health-household/vision-care",
"name": "Vision Care",
"order": 1,
"nodeId": "6171da5bbfdcf11c02a617cf",
"parentId": "6171d9b9bfdcf11c02a61791",
"children": [{"url": "/health-household/vision-care/glasses",
"name": "Reading Glasses",
"order": 0,
"nodeId": "6171da7ebfdcf11c02a617e0",
"parentId": "6171da5bbfdcf11c02a617cf"
},
{"url": "/health-household/vision-care/contacts",
"name": "Contact Lenses",
"order": 1,
"nodeId": "6171da8abfdcf11c02a617e5",
"parentId": "6171da5bbfdcf11c02a617cf"
},
{"url": "/health-household/vision-care/contacts-care",
"name": "Contact Lens Care",
"order": 2,
"nodeId": "6171da90bfdcf11c02a617ea",
"parentId": "6171da5bbfdcf11c02a617cf"
}
]
},
{"url": "/health-household/medical",
"name": "Medical Supplies & Equipment",
"order": 2,
"nodeId": "6171da67bfdcf11c02a617d4",
"parentId": "6171d9b9bfdcf11c02a61791"
}
]
}
],
"menuId": "6171d977bfdcf11c02a61771"
}
}