Developers
Menus8

Reorder menu items

PUT/menus/{menu_key}/items/order

Sets the display order of the menu items.

The ids array must contain the public ID of every item in the menu, in the desired order. Partial reordering is not supported. If the supplied set does not match, the API returns the order_set_mismatch error code and the existing order remains unchanged.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

menu_key*string

Key of the menu.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/menus/string/items/order" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "string"    ]  }'
{  "data": [    {      "destination": {        "embed": "string",        "product_id": "string",        "shortcut": "string",        "showcase_id": "string",        "url": "string"      },      "id": "string",      "kind": "shortcut",      "label": "string",      "object": "menu_item",      "position": 0,      "revision": "string",      "target": "_self",      "visible": true    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Create a menu item POST

Creates a menu item. New items are added to the end of the menu. URL and embed destinations must use the HTTP or HTTPS scheme. Product and showcase destinations must reference a product or showcase that exists in the current account.

Retrieve a menu item GET

Retrieves a menu item by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the menu item to avoid overwriting a newer version.