Skip to main content
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

Specialized Menu Creation
  • Create breakfast menus with specific morning items
  • Build lunch menus excluding breakfast-only products
  • Design dinner menus with premium items
  • Develop limited-time offer menus with promotional items
Category-Based Menu Building
  • Include entire beverage category in all menus
  • Add all dessert items to dinner menus
  • Include fresh produce in healthy eating menus
  • Add seasonal items to special event menus
Selective Item Management
  • Exclude high-cost items from discount menus
  • Include only available items in current inventory menus
  • Add featured items to promotional menus
  • Remove discontinued items from all menus
Multi-Menu Coordination
  • Apply consistent item sets across franchise locations
  • Coordinate promotional items across multiple menus
  • Standardize core offerings while allowing customization
  • Manage inventory-driven menu changes

​
Item Selection Logic

Processing Order
  1. Category Inclusion: All items from specified categories are added
  2. Individual Inclusion: Specific items from included_ids are added
  3. Exclusion Processing: Items in excluded_ids are removed
  4. Final Validation: Ensure all included items are valid and available
Conflict Resolution
  • Excluded items override category inclusions
  • Individual inclusions override category-based exclusions
  • Invalid item IDs are silently skipped
  • Empty arrays are processed without errors
Inventory Integration
  • Only available inventory items can be included
  • Out-of-stock items may be automatically excluded
  • Seasonal availability affects item inclusion
  • Real-time inventory updates influence menu item visibility

​
Validation Rules

​
Error Handling

Invalid Menu IDs
{
  "error": "Invalid menu IDs",
  "message": "One or more menu IDs do not exist or are not accessible",
  "invalid_menus": ["invalid-menu-id"]
}
Invalid Item IDs
{
  "error": "Invalid item IDs",
  "message": "Some items could not be found in inventory",
  "invalid_items": ["invalid-item-id-1", "invalid-item-id-2"]
}
Store Access Error
{
  "error": "Store access denied",
  "message": "Insufficient permissions to modify menus for this store"
}
Empty Request
{
  "error": "Invalid request",
  "message": "At least one of category_ids or included_ids must be specified"
}

​
Best Practices

​
Integration Patterns

Inventory Integration
  • Sync menu items with current inventory levels
  • Automatically update menu availability based on stock
  • Handle inventory-driven item exclusions
  • Coordinate with procurement and supply chain systems
Point-of-Sale Integration
  • Update POS systems with current menu item associations
  • Ensure consistent item availability across all channels
  • Coordinate pricing and promotional information
  • Sync modifier and customization options
Customer-Facing Systems
  • Update mobile apps and websites with current menu items
  • Ensure consistent customer experience across platforms
  • Coordinate with ordering and delivery systems
  • Maintain real-time accuracy for customer-facing displays
Analytics and Reporting
  • Track menu item performance and customer preferences
  • Analyze the impact of menu changes on sales
  • Generate insights for menu optimization
  • Support data-driven menu management decisions
Item Addition Process
  • Validate item eligibility for menu inclusion
  • Configure item-specific menu settings
  • Update all related systems and platforms
  • Monitor customer response and performance
Ongoing Management
  • Regular review of menu item performance
  • Adjustment based on inventory and seasonal factors
  • Coordination with promotional and marketing activities
  • Optimization based on customer feedback and analytics
Item Removal Process
  • Plan removal strategy to minimize customer disruption
  • Update all systems and customer-facing platforms
  • Archive historical data for analysis and reporting
  • Document reasons for removal for future reference
Performance Monitoring
  • Track individual item contribution to menu success
  • Monitor customer engagement with specific items
  • Analyze seasonal and promotional performance patterns
  • Use data insights to optimize future menu configurations
⌘I