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": {
    },
  • "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": {
    }
}

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

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

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
[
  • {
    },
  • {
    }
]

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
[
  • {
    },
  • {
    }
]

Menu

XM Menu API allows you to fetch menus and their items

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

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

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": {
    },
  • "menu": {
    }
}