POST
/
stores
/
{store_id}
/
menu
/
items?active=true
{
  "message": "<string>",
  "success": true
}
This endpoint manages the association of items with specific menus, allowing precise control over which products are available in each menu configuration.
Menu item management provides granular control over product visibility, enabling businesses to create specialized menus for different times, customer segments, or operational requirements.

Path Parameters

store_id
string
required
The unique identifier of the store to add menu items for

Query Parameters

active
boolean
default:"true"
Whether to set the menu items as active upon creation

Request Body

menu_ids
array
required
Array of menu identifiers to add items to
category_ids
array
Array of category identifiers to include in the menus (adds all items in these categories)
excluded_ids
array
Array of specific item identifiers to exclude from the menu
included_ids
array
required
Array of specific item identifiers to include in the menu

Request Example

{
    "menu_ids": [
        "813f8ac7-cae5-4d2d-92ef-d6798547f95c"
    ],
    "category_ids": [],
    "excluded_ids": [],
    "included_ids": [
        "c81d64ff-0651-48af-ab61-9b503be9f020",
        "3e3e0adb-5555-4832-9632-8bb71d861281"
    ]
}

Response

message
string
Confirmation message indicating the operation result
success
boolean
Whether the operation completed successfully

Response Example

{
    "message": "Store item(s) menu updated",
    "success": true
}
Inclusion Priority: Individual item inclusions and exclusions take precedence over category-based selections, allowing for fine-tuned menu control.
Batch Operations: Use multiple menu_ids to apply the same item configuration across several menus simultaneously, improving efficiency for multi-menu updates.

Use Cases

Item Selection Logic

Validation Rules

Error Handling

Best Practices

Integration Patterns