XM (1.0.0)

Download OpenAPI specification:Download

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

Design, deploy, and manage experiences for all your digital storefronts with fabric XM, a headless e-commerce CMS. Design and develop components in your storefront to give your merchandisers and marketers the building blocks they need to create pages for products, promotions, and campaigns.

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 header is a JSON object that must contain your account ID. 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 header is a JSON object that must contain your account ID. 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"
}
]
}
}

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 header is a JSON object that must contain your account ID. 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 Menu List

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

Request

header Parameters

object

The x-site-context header is a JSON object that must contain your account ID. 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 header is a JSON object that must contain your account ID. 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": [ ]
}
]
}
]
}
]
}
}