Download OpenAPI specification:Download
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.
Returns a list of all the live pages for the specified channels
object The |
Successful operation
The request was received but no data matches the request parameters
The request was received but an internal error occurred.
{- "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": {
- "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"
}
}
]
}
}
Returns the live page for the specified page url and channel
object The |
Successful operation
Page is not live or is inactive
Page url not specified
Page not found
The request was received but an internal error occurred
{- "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": {
- "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"
}
]
}
}
Returns a list of all the live global component data for a specified channel
Successful operation
The request was received but an internal error occurred
[- {
- "_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",
- "components": [ ]
}, - {
- "title": "API documentation",
- "description": "Customize without limits",
- "components": [ ]
}
]
}, - "order": 1
}
]
Returns the live menu of the specified channel along with all its menu items
object The |
Successful operation
Menu not found
The request was received but an internal error occurred
{- "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,
- "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"
}
}