Table of Contents

Order Model Reference

This page provides a detailed lexicon for each section and object in the UEAT Open API v2 Order Model. Use this as a reference when building or validating order payloads.

Location

  • Id: Unique GUID for the restaurant location.
  • Name: Name of the restaurant or location.
    • Ex :
  • PhoneNumber: Contact number for the location.
    • Ex : +1 418 555 1231
  • Address: Physical address of the restaurant.
    • Unit: Optional unit or suite number.
    • CivicNumber: Street number.
    • StreetName: Street name.
    • City: City name.
    • PostalCode: Postal code.

OrderIds

  • OrderId: Internal order number from UEAT.
  • ExternalOrderId: Marketplace order ID (null if not applicable).

Customer

  • FirstName, LastName: Customer’s name.
  • PhoneNumber: Customer’s phone number.
  • Email: Customer’s email address.
  • Allergies: Allergy information (null if none provided).

DeliveryInfo

  • Address: Delivery address (same structure as Location.Address).
  • DeliveryTime: Scheduled delivery time. When the food needs to be in the customer's hands.
  • DeliveryNotes: Special instructions for delivery.
  • ExternalDeliveryId: ID for external delivery service such as UberDirect (if applicable).

OrderTime

  • PreparationType: Enum (ASAP or Preorder).
  • PickupDateTime: Scheduled pickup time. When the food needs to be ready.
    • If the PreparationType is ASAP, the PickupDateTime will be the time the order was done plus the preparation time configured in UEAT.

Items

  • Id: Item identifier from the POS.
  • Name: Item name.
    • Language : UEAT will always send the POS name coming from the synchronization.
  • Quantity: Number of units ordered.
  • UnitPrice: Price in cents (undiscounted).
  • Modifiers: Array of modifier items.
  • Note: Optional note for the item.
    • Ex : Cooking instructions
  • HasFederalTax, HasProvincialTax: Boolean flags for tax applicability.

Promotions

  • Name: Promotion name.
  • Amount: Discount amount in cents.

Fees

  • Id: Fee identifier. (Not mandatory except Bag fee)
  • Amount: Fee amount in cents.
  • Type: Enum (Bag, Allergy, Delivery, service, other.).

PersonalizedQuestions

  • Label: Question text.
  • Answer: Customer’s answer.

The question and the answer is part of the same note.

Service

The Service object defines how and from where an order is initiated, how it is fulfilled, and the operational context in which it must be processed.

  • Channel: Enum (e.g., Web, Kiosk, UberEats, Doordash, SkipTheDishes).
  • Mobile app is currently under OO
  • OrderType: Enum (service type such as : Pickup, Delivery, etc).
  • GenericServiceType: High‑level service classification used for exceptional or hub‑specific scenarios not supported by standard service types; conventionally, 5 to 9 are allocated to the Hub.
  • ProximityDeliveryInfo: Additional info for delivery proximity. Ex : Table # for a Table service.
  • KioskId: ID of the kiosk (if applicable).
    • Allow to identify from which kiosk the order is coming from.

CounterNotes

  • Notes for the staff working at the counter on a take-out order only.

Payment

  • Details: Array of payment splits. Empty if IsOrderPaid is false.
    • Amount: Payment amount in cents.
    • PaymentType: Enum (CreditCard, Loyalty, Marketplace, none).
  • IsOrderPaid: Boolean indicating if the order is paid.
  • PaymentDateTime: Timestamp of the payment.
  • SubTotal: Subtotal before taxes.
  • Taxes: Array of tax details.
    • Amount, Name, Type.
  • Tips: Tip amount in cents.
    • Only the tip going to the restaurant staff is exposed in this payload. Mechanic around a 3rd Party Delivery Tip.
  • Total: Total amount including taxes and tips if perceived by the restaurant.

For a full example of the order payload, see the Order Model page.