Skip to main content
PUT
/
stores
/
{store_id}
/
menus
/
{menu_id}
/
items
/
{item_id}
{
  "message": "<string>",
  "success": true,
  "updated_item": {}
}
This endpoint provides comprehensive menu item update capabilities, allowing businesses to adjust item properties, pricing, availability, and other menu-specific configurations while maintaining system consistency.
Menu item updates enable dynamic menu management, allowing businesses to respond to inventory changes, promotional requirements, and operational needs in real-time.

Path Parameters

store_id
string
required
The unique identifier of the store containing the menu
menu_id
string
required
The unique identifier of the menu containing the item to update
item_id
string
required
The unique identifier of the item to update

Request Body

is_available
boolean
Controls whether the item is available for ordering in this menu
menu_specific_price
number
Custom pricing for this item within this specific menu (overrides base item price)
display_order
integer
Controls the display order of the item within the menu
menu_item_description
string
Menu-specific description that overrides the default item description
promotional_tags
array
Array of promotional tags specific to this menu item association
menu_item_modifiers
object
Menu-specific modifier configurations for this item

Request Example

{
    "is_available": true,
    "menu_specific_price": 12.99,
    "display_order": 5,
    "menu_item_description": "Fresh grilled salmon with seasonal vegetables",
    "promotional_tags": ["featured", "healthy"],
    "menu_item_modifiers": {
        "cooking_preferences": ["medium", "well-done"],
        "side_options": ["rice", "vegetables", "salad"]
    }
}

Response

message
string
Confirmation message indicating the operation result
success
boolean
Whether the update operation completed successfully
updated_item
object
Details of the updated menu item configuration

Response Example

{
    "message": "Menu item updated successfully",
    "success": true,
    "updated_item": {
        "item_id": "c81d64ff-0651-48af-ab61-9b503be9f020",
        "menu_id": "813f8ac7-cae5-4d2d-92ef-d6798547f95c",
        "is_available": true,
        "menu_specific_price": 12.99,
        "display_order": 5,
        "last_updated": "2024-01-15T10:30:00Z"
    }
}
Menu-Specific Settings: Updates apply only to the specific menu-item association. The base item properties remain unchanged unless specifically modified through item management endpoints.
Batch Updates: For updating multiple items with similar changes, consider implementing batch update logic in your application to reduce API calls and improve performance.

Use Cases

Dynamic Availability Management
  • Toggle item availability based on inventory levels
  • Handle equipment maintenance affecting specific items
  • Manage staffing limitations for complex preparations
  • Control availability during special events or promotions
Promotional Campaigns
  • Update pricing for limited-time offers
  • Add promotional tags and descriptions
  • Adjust display order to feature promoted items
  • Configure special modifiers for promotional periods
Seasonal Adjustments
  • Update descriptions to reflect seasonal ingredients
  • Adjust pricing for seasonal cost variations
  • Modify availability based on seasonal supply
  • Update promotional tags for seasonal marketing
Menu Optimization
  • Reorder items based on performance data
  • Update descriptions based on customer feedback
  • Adjust pricing based on market analysis
  • Optimize modifier configurations for efficiency

Update Field Details

Availability Control
  • is_available: Controls immediate customer access to the item
  • Affects all customer-facing systems and ordering platforms
  • Does not remove the item from the menu structure
  • Enables quick response to operational changes
Pricing Management
  • menu_specific_price: Overrides base item pricing for this menu
  • Supports menu-specific pricing strategies
  • Enables promotional pricing without affecting other menus
  • Maintains pricing flexibility across different contexts
Display Optimization
  • display_order: Controls item position within menu sections
  • Lower numbers appear first in the display order
  • Enables strategic positioning of high-margin or popular items
  • Supports logical grouping and customer flow optimization
Content Customization
  • menu_item_description: Menu-specific item description
  • Overrides base item description for this menu context
  • Supports targeted messaging for specific customer segments
  • Enables localization and customization
Promotional Enhancement
  • promotional_tags: Array of tags for marketing and display
  • Supports visual highlighting in customer interfaces
  • Enables filtering and categorization for promotions
  • Provides metadata for analytics and reporting
Modifier Configuration
  • menu_item_modifiers: Menu-specific modifier settings
  • Allows different modifier options per menu
  • Supports context-appropriate customization options
  • Enables menu-specific operational workflows

Validation Rules

Menu and Item Validation
  • Menu ID must exist and belong to the specified store
  • Item ID must exist and be associated with the specified menu
  • User must have appropriate permissions for menu modifications
  • Menu must be in a valid state for updates
Data Validation
  • Pricing values must be positive numbers with appropriate precision
  • Display order must be a valid integer
  • Description length must be within system limits
  • Promotional tags must be from approved tag sets
Business Rule Validation
  • Price changes must comply with business pricing policies
  • Availability changes must consider inventory and operational constraints
  • Display order changes must maintain menu structure integrity
  • Modifier configurations must be valid for the item type
System Validation
  • All referenced modifiers and options must exist
  • Promotional tags must be valid and active
  • Price formats must match system requirements
  • Description content must meet content policy requirements

Error Handling

Invalid Menu Item Association
{
  "error": "Menu item not found",
  "message": "The specified item is not associated with this menu",
  "details": {
    "menu_id": "813f8ac7-cae5-4d2d-92ef-d6798547f95c",
    "item_id": "invalid-item-id"
  }
}
Invalid Price Value
{
  "error": "Invalid price",
  "message": "Menu specific price must be a positive number",
  "provided_value": -5.99
}
Permission Denied
{
  "error": "Permission denied",
  "message": "Insufficient permissions to update items in this menu"
}
Business Rule Violation
{
  "error": "Business rule violation",
  "message": "Price change exceeds maximum allowed variance from base price",
  "details": {
    "base_price": 10.99,
    "requested_price": 25.99,
    "max_variance": "50%"
  }
}

Best Practices

Integration Patterns

Real-time Synchronization
  • Ensure immediate propagation to all customer-facing systems
  • Update point-of-sale systems with current item configurations
  • Synchronize with mobile apps and online ordering platforms
  • Coordinate with third-party delivery and ordering services
Inventory Integration
  • Sync availability updates with inventory management systems
  • Automatically adjust availability based on stock levels
  • Coordinate pricing updates with cost management systems
  • Integrate with procurement and supply chain systems
Analytics and Reporting
  • Track update patterns and their impact on sales
  • Monitor customer response to pricing and availability changes
  • Generate insights for menu optimization strategies
  • Support data-driven decision making
Customer Experience Integration
  • Ensure consistent presentation across all customer touchpoints
  • Update search and recommendation algorithms with new configurations
  • Maintain accurate nutritional and allergen information
  • Support personalization and customer preference systems
Introduction Phase
  • Set initial availability and pricing
  • Configure promotional tags for new item launches
  • Optimize display order for customer discovery
  • Monitor performance and adjust configuration accordingly
Growth and Optimization
  • Adjust pricing based on demand and cost analysis
  • Optimize display order based on customer behavior
  • Update descriptions based on customer feedback
  • Fine-tune modifier configurations for operational efficiency
Maturity Management
  • Maintain optimal pricing and positioning
  • Adjust availability based on inventory optimization
  • Update promotional strategies based on market position
  • Monitor competitive positioning and adjust accordingly
Decline and Phase-out
  • Gradually reduce visibility through display order adjustments
  • Implement clearance pricing strategies
  • Manage availability during inventory depletion
  • Plan removal strategy while maintaining customer satisfaction

Performance Monitoring

Customer Impact Analysis
  • Track ordering patterns before and after updates
  • Monitor customer feedback and satisfaction scores
  • Analyze impact on average order value and frequency
  • Measure customer discovery and selection rates
Operational Impact Assessment
  • Monitor kitchen efficiency and preparation times
  • Track inventory turnover and waste reduction
  • Analyze staff efficiency with updated configurations
  • Measure overall operational performance changes
Business Performance Metrics
  • Track revenue impact of pricing and availability changes
  • Monitor profit margin improvements from optimization
  • Analyze competitive positioning and market share
  • Measure ROI of menu management activities
System Performance Monitoring
  • Track API response times and system performance
  • Monitor integration effectiveness across platforms
  • Analyze data consistency and synchronization success
  • Measure customer experience quality across touchpoints
I