Servd Agentic Ordering

{'type': 'object', 'required': ['order_id'], 'properties': {'order_id': {'type': 'string', 'description': 'The machine-facing orderId from place_order.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['sandbox', 'createsProductionOrder', 'orderId', 'orderNumber', 'state', 'status', 'paymentStatus', 'paymentMethod', 'paid', 'total', 'currency', 'venue', 'placedAt', 'expiresAt', 'estimatedReadyMinutes', 'friendlyId', 'trackingUrl', 'trackUrl', 'message'], 'properties': {'paid': {'type': 'boolean'}, 'state': {'enum': ['awaiting_payment', 'expired', 'paid', 'preparing', 'ready', 'out_for_delivery', 'completed', 'cancelled'], 'type': 'string'}, 'total': {'type': 'integer', 'description': 'Total in minor currency units.'}, 'venue': {'anyOf': [{'type': 'object', 'required': ['slug', 'name'], 'properties': {'name': {'type': 'string'}, 'slug': {'type': 'string'}}, 'additionalProperties': False}, {'type': 'null'}]}, 'status': {'type': 'string'}, 'message': {'type': 'string'}, 'orderId': {'type': 'string'}, 'sandbox': {'type': 'boolean'}, 'currency': {'type': 'string'}, 'placedAt': {'type': 'string', 'format': 'date-time'}, 'trackUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'expiresAt': {'type': ['string', 'null'], 'format': 'date-time'}, 'friendlyId': {'type': ['string', 'null']}, 'orderNumber': {'type': ['string', 'null']}, 'trackingUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'paymentMethod': {'type': ['string', 'null']}, 'paymentStatus': {'type': ['string', 'null']}, 'estimatedReadyMinutes': {'type': ['integer', 'null'], 'minimum': 0}, 'createsProductionOrder': {'type': 'boolean'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1}, 'query': {'type': 'string', 'description': 'Optional name or city filter, case-insensitive.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['count', 'venues'], 'properties': {'count': {'type': 'integer', 'minimum': 0}, 'venues': {'type': 'array', 'items': {'type': 'object', 'required': ['slug', 'name', 'city', 'country'], 'properties': {'city': {'type': ['string', 'null']}, 'name': {'type': 'string'}, 'slug': {'type': 'string'}, 'country': {'type': ['string', 'null']}}, 'additionalProperties': False}}}, 'additionalProperties': False}

{'type': 'object', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'description': 'The venue slug.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['venue', 'currency', 'categories'], 'properties': {'venue': {'type': 'string', 'description': 'Venue slug.'}, 'currency': {'type': 'string', 'description': 'ISO 4217 currency code.'}, 'categories': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'name', 'nameAr', 'descriptionAr', 'sortOrder', 'imageUrl', 'items'], 'properties': {'id': {'type': 'string'}, 'name': {'type': 'string'}, 'items': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'name', 'nameAr', 'description', 'descriptionAr', 'price', 'salePrice', 'currency', 'available', 'imageUrl', 'tags', 'modifierGroups', 'quantity'], 'properties': {'id': {'type': 'string'}, 'name': {'type': 'string'}, 'tags': {'type': 'array', 'items': {'type': 'string'}}, 'price': {'type': 'string', 'pattern': '^[0-9]+\\.[0-9]{2}$'}, 'nameAr': {'type': ['string', 'null']}, 'currency': {'type': 'string'}, 'imageUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'quantity': {'type': 'object', 'required': ['min', 'max', 'step'], 'properties': {'max': {'type': 'integer', 'minimum': 1}, 'min': {'type': 'integer', 'minimum': 1}, 'step': {'type': 'integer', 'minimum': 1}}, 'additionalProperties': False}, 'available': {'type': 'boolean'}, 'salePrice': {'type': ['string', 'null'], 'pattern': '^[0-9]+\\.[0-9]{2}$'}, 'description': {'type': 'string'}, 'descriptionAr': {'type': ['string', 'null']}, 'modifierGroups': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'nameAr', 'required', 'min', 'max', 'options'], 'properties': {'max': {'type': 'integer', 'minimum': 0}, 'min': {'type': 'integer', 'minimum': 0}, 'name': {'type': 'string'}, 'nameAr': {'type': ['string', 'null']}, 'options': {'type': 'array', 'items': {'type': 'object', 'required': ['name', 'nameAr', 'priceAdjustment'], 'properties': {'name': {'type': 'string'}, 'nameAr': {'type': ['string', 'null']}, 'priceAdjustment': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}}, 'required': {'type': 'boolean'}}, 'additionalProperties': False}}}, 'additionalProperties': False}}, 'nameAr': {'type': ['string', 'null']}, 'imageUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'sortOrder': {'type': 'integer'}, 'descriptionAr': {'type': ['string', 'null']}}, 'additionalProperties': False}}}, 'additionalProperties': False}

{'type': 'object', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'description': 'The venue slug.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['id', 'slug', 'name', 'currency', 'phone', 'email', 'address', 'timezone', 'url', 'orderUrl', 'logoUrl', 'coverUrl', 'rating', 'openNow', 'hours', 'serviceModes', 'acceptsReservations', 'agentOrdering', 'policies'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string', 'format': 'uri'}, 'name': {'type': 'string'}, 'slug': {'type': 'string'}, 'email': {'type': ['string', 'null']}, 'hours': {'type': 'array', 'items': {'type': 'object', 'required': ['day', 'opens', 'closes', 'closed', 'is24h'], 'properties': {'day': {'type': 'integer', 'maximum': 6, 'minimum': 0}, 'is24h': {'type': 'boolean'}, 'opens': {'type': ['string', 'null']}, 'closed': {'type': 'boolean'}, 'closes': {'type': ['string', 'null']}}, 'additionalProperties': False}}, 'phone': {'type': ['string', 'null']}, 'rating': {'anyOf': [{'type': 'object', 'required': ['value', 'count'], 'properties': {'count': {'type': 'integer', 'minimum': 0}, 'value': {'type': 'number'}}, 'additionalProperties': False}, {'type': 'null'}]}, 'address': {'type': 'object', 'required': ['line1', 'city', 'country', 'latitude', 'longitude'], 'properties': {'city': {'type': ['string', 'null']}, 'line1': {'type': ['string', 'null']}, 'country': {'type': ['string', 'null']}, 'latitude': {'type': ['number', 'null']}, 'longitude': {'type': ['number', 'null']}}, 'additionalProperties': False}, 'logoUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'openNow': {'type': 'boolean'}, 'coverUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'currency': {'type': 'string', 'description': 'ISO 4217 currency code.'}, 'orderUrl': {'type': 'string', 'format': 'uri'}, 'policies': {'type': 'array', 'items': {'type': 'object', 'required': ['type', 'url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}, 'type': {'type': 'string'}}, 'additionalProperties': False}}, 'timezone': {'type': ['string', 'null']}, 'serviceModes': {'type': 'object', 'required': ['dineIn', 'pickup', 'delivery'], 'properties': {'dineIn': {'type': 'boolean'}, 'pickup': {'type': 'boolean'}, 'delivery': {'type': 'boolean'}}, 'additionalProperties': False}, 'agentOrdering': {'type': 'object', 'required': ['enabled', 'paymentMode', 'sandbox'], 'properties': {'enabled': {'type': 'boolean'}, 'sandbox': {'type': 'boolean', 'description': 'True only for an explicit reviewer tenant. Confirmed creates are simulated and never reach payment or a kitchen.'}, 'paymentMode': {'enum': ['instant', 'link', 'none'], 'type': 'string'}}, 'additionalProperties': False}, 'acceptsReservations': {'type': 'boolean'}}, 'additionalProperties': False}

{'type': 'object', 'anyOf': [{'required': ['items']}, {'required': ['combos']}], 'required': ['slug', 'fulfillment', 'customer', 'confirmed', 'confirmation_token', 'idempotency_key'], 'properties': {'slug': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'The venue slug returned by find_venues.'}, 'items': {'type': 'array', 'items': {'type': 'object', 'required': ['menu_item_id', 'quantity'], 'properties': {'quantity': {'type': 'integer', 'maximum': 99, 'minimum': 1}, 'menu_item_id': {'type': 'string', 'maxLength': 128, 'minLength': 1, 'description': 'The item id returned by get_menu.'}, 'selected_modifiers': {'type': 'array', 'items': {'type': 'object', 'required': ['group', 'name'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'group': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'price_adj': {'type': 'number', 'description': 'Informational major-unit amount from get_menu; the server recalculates it.'}}, 'additionalProperties': False}, 'maxItems': 50}, 'special_instructions': {'type': 'string', 'maxLength': 1000}}, 'additionalProperties': False}, 'maxItems': 100, 'minItems': 1}, 'combos': {'type': 'array', 'items': {'type': 'object', 'required': ['combo_id', 'quantity'], 'properties': {'combo_id': {'type': 'string', 'maxLength': 128, 'minLength': 1}, 'quantity': {'type': 'integer', 'maximum': 99, 'minimum': 1}}, 'additionalProperties': False}, 'maxItems': 100, 'minItems': 1}, 'customer': {'type': 'object', 'required': ['name', 'phone'], 'properties': {'name': {'type': 'string', 'maxLength': 200}, 'email': {'type': 'string', 'format': 'email', 'maxLength': 320}, 'phone': {'type': 'string', 'maxLength': 64}}, 'description': 'The diner’s minimum contact details required by the venue.', 'additionalProperties': False}, 'delivery': {'type': 'object', 'properties': {'city': {'type': 'string', 'maxLength': 200}, 'floor': {'type': 'string', 'maxLength': 200}, 'street': {'type': 'string', 'maxLength': 500}, 'building': {'type': 'string', 'maxLength': 200}, 'latitude': {'type': 'number', 'maximum': 90, 'minimum': -90}, 'apartment': {'type': 'string', 'maxLength': 200}, 'longitude': {'type': 'number', 'maximum': 180, 'minimum': -180}}, 'description': 'For delivery, street is required and coordinates may be needed for fees/radius.', 'additionalProperties': False}, 'confirmed': {'type': 'boolean', 'const': True, 'description': 'Set true only after the diner explicitly confirms the latest validate_cart result.'}, 'tip_amount': {'type': 'number', 'minimum': 0, 'description': 'Major currency units.'}, 'fulfillment': {'enum': ['pickup', 'delivery'], 'type': 'string'}, 'payment_method': {'enum': ['cash', 'online'], 'type': 'string', 'default': 'online'}, 'idempotency_key': {'type': 'string', 'maxLength': 255, 'minLength': 1, 'description': 'Use validate_cart.confirmation.idempotencyKey exactly; reuse it for retries of this confirmed order.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'minLength': 1, 'description': 'The short-lived confirmation.token from the exact validate_cart result shown to the diner.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['sandbox', 'createsProductionOrder', 'orderId', 'orderNumber', 'friendlyId', 'paymentRequired', 'paymentMode', 'paymentProvider', 'paymentUrl', 'trackingUrl', 'customerLinks', 'checkoutUrl', 'trackUrl', 'statusUrl', 'expiresAt', 'paymentError', 'message'], 'properties': {'message': {'type': 'string'}, 'orderId': {'type': 'string', 'description': 'Machine-facing private id for check_order.'}, 'sandbox': {'type': 'boolean'}, 'trackUrl': {'type': 'string', 'format': 'uri'}, 'expiresAt': {'type': ['string', 'null'], 'format': 'date-time'}, 'statusUrl': {'type': 'string', 'format': 'uri'}, 'friendlyId': {'type': 'string'}, 'paymentUrl': {'type': ['string', 'null'], 'format': 'uri'}, 'checkoutUrl': {'type': 'string', 'format': 'uri'}, 'orderNumber': {'type': 'string', 'description': 'Customer-facing order number.'}, 'paymentMode': {'enum': ['instant', 'link', 'none'], 'type': 'string'}, 'trackingUrl': {'type': 'string', 'format': 'uri'}, 'paymentError': {'type': ['string', 'null']}, 'customerLinks': {'type': 'object', 'required': ['payment', 'tracking'], 'properties': {'payment': {'anyOf': [{'type': 'object', 'required': ['label', 'url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}, 'label': {'type': 'string'}}, 'additionalProperties': False}, {'type': 'null'}]}, 'tracking': {'type': 'object', 'required': ['label', 'url'], 'properties': {'url': {'type': 'string', 'format': 'uri'}, 'label': {'type': 'string'}}, 'additionalProperties': False}}, 'additionalProperties': False}, 'paymentProvider': {'type': ['string', 'null']}, 'paymentRequired': {'type': 'boolean'}, 'createsProductionOrder': {'type': 'boolean', 'description': 'False for reviewer sandbox receipts. True only when a production order was created.'}}, 'additionalProperties': False}

{'type': 'object', 'anyOf': [{'required': ['items']}, {'required': ['combos']}], 'required': ['slug', 'fulfillment'], 'properties': {'slug': {'type': 'string', 'maxLength': 160, 'minLength': 1, 'description': 'The venue slug returned by find_venues.'}, 'items': {'type': 'array', 'items': {'type': 'object', 'required': ['menu_item_id', 'quantity'], 'properties': {'quantity': {'type': 'integer', 'maximum': 99, 'minimum': 1}, 'menu_item_id': {'type': 'string', 'maxLength': 128, 'minLength': 1, 'description': 'The item id returned by get_menu.'}, 'selected_modifiers': {'type': 'array', 'items': {'type': 'object', 'required': ['group', 'name'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'group': {'type': 'string', 'maxLength': 200, 'minLength': 1}, 'price_adj': {'type': 'number', 'description': 'Informational major-unit amount from get_menu; the server recalculates it.'}}, 'additionalProperties': False}, 'maxItems': 50}, 'special_instructions': {'type': 'string', 'maxLength': 1000}}, 'additionalProperties': False}, 'maxItems': 100, 'minItems': 1}, 'combos': {'type': 'array', 'items': {'type': 'object', 'required': ['combo_id', 'quantity'], 'properties': {'combo_id': {'type': 'string', 'maxLength': 128, 'minLength': 1}, 'quantity': {'type': 'integer', 'maximum': 99, 'minimum': 1}}, 'additionalProperties': False}, 'maxItems': 100, 'minItems': 1}, 'customer': {'type': 'object', 'properties': {'name': {'type': 'string', 'maxLength': 200}, 'email': {'type': 'string', 'format': 'email', 'maxLength': 320}, 'phone': {'type': 'string', 'maxLength': 64}}, 'additionalProperties': False}, 'delivery': {'type': 'object', 'properties': {'city': {'type': 'string', 'maxLength': 200}, 'floor': {'type': 'string', 'maxLength': 200}, 'street': {'type': 'string', 'maxLength': 500}, 'building': {'type': 'string', 'maxLength': 200}, 'latitude': {'type': 'number', 'maximum': 90, 'minimum': -90}, 'apartment': {'type': 'string', 'maxLength': 200}, 'longitude': {'type': 'number', 'maximum': 180, 'minimum': -180}}, 'additionalProperties': False}, 'tip_amount': {'type': 'number', 'minimum': 0, 'description': 'Major currency units.'}, 'fulfillment': {'enum': ['pickup', 'delivery'], 'type': 'string'}, 'payment_method': {'enum': ['cash', 'online'], 'type': 'string', 'default': 'online'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['valid', 'createsOrder', 'venue', 'fulfillment', 'paymentMethod', 'paymentMode', 'lines', 'totals', 'confirmation', 'requirements'], 'properties': {'lines': {'type': 'array', 'items': {'type': 'object', 'required': ['menu_item_id', 'item_name', 'unit_price', 'quantity', 'line_total', 'discount_amount', 'combo_id', 'selected_modifiers'], 'properties': {'combo_id': {'type': ['string', 'null']}, 'quantity': {'type': 'integer', 'minimum': 1}, 'item_name': {'type': 'string'}, 'line_total': {'type': 'integer', 'description': 'Authoritative minor-unit line total.'}, 'unit_price': {'type': 'integer', 'description': 'Authoritative minor-unit price.'}, 'menu_item_id': {'type': 'string'}, 'discount_amount': {'type': 'integer', 'minimum': 0}, 'selected_modifiers': {'type': 'array', 'items': {'type': 'object', 'required': ['group', 'name', 'price_adj'], 'properties': {'name': {'type': 'string'}, 'group': {'type': 'string'}, 'price_adj': {'type': 'integer', 'description': 'Authoritative minor-unit adjustment.'}}, 'additionalProperties': False}}}, 'additionalProperties': False}, 'minItems': 1}, 'valid': {'type': 'boolean', 'const': True}, 'venue': {'type': 'object', 'required': ['id', 'slug', 'name', 'currency', 'sandbox'], 'properties': {'id': {'type': 'string'}, 'name': {'type': 'string'}, 'slug': {'type': 'string'}, 'sandbox': {'type': 'boolean'}, 'currency': {'type': 'string'}}, 'additionalProperties': False}, 'totals': {'type': 'object', 'required': ['currency', 'subtotal', 'discount', 'tax', 'serviceCharge', 'deliveryFee', 'tip', 'total'], 'properties': {'tax': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'tip': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'total': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'currency': {'type': 'string'}, 'discount': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'subtotal': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'deliveryFee': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}, 'serviceCharge': {'type': 'object', 'required': ['minor', 'decimal'], 'properties': {'minor': {'type': 'integer', 'description': 'Amount in the currency minor unit.'}, 'decimal': {'type': 'string', 'pattern': '^-?[0-9]+\\.[0-9]{2}$'}}, 'additionalProperties': False}}, 'additionalProperties': False}, 'fulfillment': {'enum': ['pickup', 'delivery'], 'type': 'string'}, 'paymentMode': {'enum': ['instant', 'link', 'none'], 'type': 'string'}, 'confirmation': {'type': 'object', 'required': ['token', 'expiresAt', 'idempotencyKey', 'boundToLatestQuote'], 'properties': {'token': {'type': ['string', 'null'], 'description': 'Short-lived signed receipt for this exact cart and quote. Null until all required customer and fulfillment fields are present.'}, 'expiresAt': {'type': ['string', 'null'], 'format': 'date-time'}, 'idempotencyKey': {'type': ['string', 'null'], 'description': 'Use this exact value as place_order.idempotency_key. Null until the request is complete.'}, 'boundToLatestQuote': {'type': 'boolean', 'const': True}}, 'additionalProperties': False}, 'createsOrder': {'type': 'boolean', 'const': False}, 'requirements': {'type': 'object', 'required': ['missing', 'explicitConfirmationRequired', 'createRequestMustSet', 'confirmationTokenRequired', 'idempotencyKeyRequired'], 'properties': {'missing': {'type': 'array', 'items': {'type': 'string'}}, 'createRequestMustSet': {'type': 'object', 'required': ['confirmed'], 'properties': {'confirmed': {'type': 'boolean', 'const': True}}, 'additionalProperties': False}, 'idempotencyKeyRequired': {'type': 'boolean', 'const': True}, 'confirmationTokenRequired': {'type': 'boolean', 'const': True}, 'explicitConfirmationRequired': {'type': 'boolean', 'const': True}}, 'additionalProperties': False}, 'paymentMethod': {'enum': ['cash', 'online'], 'type': 'string'}}, 'additionalProperties': False}