Structs§
- Address
- Physical address information
- Availability
- Item availability information
- Business
Hours - Business hours for a particular day
- Calculated
Values - Calculated values based on customizations
- Contact
- Contact information
- Customer
- Customer information
- Customization
- Customization options for an item
- Customization
Option - Individual option for a customization
- Delivery
- Delivery information
- EuRegulation
Info - EU regulation nutrition information
- Ingredient
Group - Ingredient grouping
- Item
- Representation of a food or beverage item
- Measurement
Value - Measurement value with unit
- Metadata
- Metadata about the OMS document
- Nutrient
With Details - Nutrient with detailed breakdown
- Nutrition
- Nutritional information about an item
- Nutrition
Standards - Nutrition standards compliance information
- OmsDocument
- Main OmsDocument struct representing a complete OpenMenuStandard document
- Order
- Order information
- Payment
- Payment information
- Popularity
- Item popularity metrics
- Selected
Customization - Selected customization for an item
- Time
Range - Time range with open and close times
- UsFda
Info - US FDA nutrition information
- Vendor
- Information about the food service provider
- Vitamin
Mineral - Vitamin or mineral nutrient information
Enums§
- Customization
Default - Default value for a customization, which varies by type
- Customization
Selection - Value of a selected customization, which varies by type
- Customization
Type - Types of customizations
- DayOf
Week - Days of the week
- Nutrient
Value - Nutrient value, which can be either a simple measurement or another detailed breakdown
- OmsError
- General error type for the OMS library
- Order
Status - Order status
- Order
Type - Order type
- Payment
Status - Payment status
Constants§
- OMS_
FILE_ EXTENSION - OpenMenuStandard file extension
- OMS_
MIME_ TYPE - OpenMenuStandard MIME type for HTTP transmission
- OMS_
URL_ SCHEME - OpenMenuStandard URL scheme
- OMS_
VERSION - Current version of the OpenMenuStandard
Functions§
- add_
custom_ params - Add custom parameters to an OMS URL
- calculate_
price_ adjustments - Calculate price adjustments for selected customizations
- create_
compact_ oms_ json - Create a compact JSON representation suitable for NFC tags
- create_
customize_ url - Create a customize URL for an item
- create_
deep_ link - Create a deep link to a document
- create_
minimal_ document - Create a minimal OMS document with basic fields
- create_
oms_ url - Create an OMS URL from components
- create_
order_ url - Create an order URL for an item
- create_
share_ url - Create a share URL for an item or document
- create_
template - Create a template OMS document for a specific vendor type
- create_
vendor_ url - Create a view URL for a vendor
- extract_
and_ update_ selections - Extract and update only the customization selections from an OMS URL
- generate_
order - Generate a complete order from a document
- is_
valid_ tap_ to_ order - Check if an OMS document is a valid tap-to-order document
- load_
document_ from_ file - Load an OMS document from a file
- parse_
oms_ document - Parse an OMS document from a JSON string
- parse_
oms_ url - Parse an OMS URL and extract the parameters
- save_
document_ to_ file - Save an OMS document to a file
- validate_
customization_ type - Validation function for customization type
- validate_
document - Validates a complete OmsDocument
- validate_
vendor_ type - Validation function for vendor type
Type Aliases§
- Extensions
- Extensions for vendor-specific or future extensions
- OmsResult
- Result type for OpenMenuStandard operations