Skip to main content
POST
Create Menu

Create Menu

Creates a new navigation menu in the store. The request body may be sent flat or wrapped in a menu object.

Request

Body Parameters

string
required
The menu name
string
required
The menu placement, e.g. Header or Footer
string
required
The kind of menu item, e.g. page, product, category, or a customized link
string
URL-safe handle
string
URL for the menu item
array
Array of child menu items (stored as-is). Each item is a free-form object, typically with name and url.
string
ID of the parent menu, when creating a nested item
integer
default:"0"
Display order

Response

Returns the standard response envelope with status 201. The data object contains a menu property holding the created menu record.

Example Response

Error Response

When a required field is missing: