Menus

This endpoint retrieves menus for a specified component, such as "header" or "footer". It is commonly used to fetch menus for a particular component in your theme, typically for dynamically rendering navigation or other UI elements. While "header" is the default component, you can specify "footer" where needed.

Payload

menus.payload

string

enum<string>

required

The name of the component for which to fetch the menu, either "header" or "footer"

Allowed values:

headerfooter

Default:

header

Response

Success

menus.response.success

status

number

required

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

required

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array [anyOf]

required

object (MenuItems)

optional

Header Menu Items

object

optional

Footer Menu Items

Usage

Header Example

Footer Example

In the case of using Header, the developer can use the example below to receive the data.

Events

The menu process may trigger two events during the menu process, onMenuFetched and onMenuFetchFailed.

onMenuFetched

Triggered when the menus are successfully fetched.

onMenuFetchFailed

Triggered if there is an error during the fetching process.

Payload#

Response#

Usage#

Events#

onMenuFetched#

onMenuFetchFailed#

Payload

Response

Usage

Events

onMenuFetched

onMenuFetchFailed