Token needs the read ability. About tokens

Path parameters

• external_id string required
  The order's point-of-sale id (the id field of an Order).

Query parameters

• business_date string (date) required
• location_id string (uuid)
  The location UUID, needed when two locations share the POS id on that date.
• include string
  Comma-separated. Allowed: items, payments.

Responses

• 200 Success
  • data Order
    One check. Fields the source did not record are null, never zero: check_number, employee_id, day_part_id and guest_count are recorded for every date before the latest one or two, which are served from the import buffer until the nightly build.
    Show 23 properties
    • id string
      The order's point-of-sale id.
    • location object
      Show 2 properties
      • id string (uuid)
      • name string
    • order_created_at string
      The store-local wall clock when the order opened, with no UTC offset. Interpret it in the location's timezone.
    • payment_at string nullable
      The store-local wall clock when the order closed, with no UTC offset.
    • business_date_on string (date)
    • check_number string nullable
    • device_id string nullable
      The POS terminal id.
    • employee_id string nullable
      The POS's opaque employee id. Never resolved to a person.
    • day_part_id string nullable
      The POS day part id.
    • channel object nullable
      Show 2 properties
      • id string
        The POS order channel id.
      • name string nullable
    • order_type object nullable
      Show 2 properties
      • id string
        The POS order type id.
      • name string nullable
    • total_amount number
    • tax_amount number
    • tip_amount number
    • service_charge_amount number
    • discount_amount number
    • gift_card_amount number nullable
    • net_sales_amount number
    • void_amount number nullable
      The POS's void total for the check; null when not reported.
    • num_customers integer
    • guest_count integer nullable
      The POS's guest count, where it reports one separately from num_customers.
    • items array of OrderItem
      Present only when include=items. Voided lines and modifiers are not listed.
      Show 8 properties
      • description string nullable
      • item_external_id string nullable
        The catalog item's point-of-sale external_id. Null when the line item is not linked to a catalog item.
      • category_uuid string (uuid) nullable
        The item category's UUID. Null when uncategorized.
      • quantity number
        Fractional where the POS sells by weight.
      • price number
      • discount_amount number
      • net_sales_amount number
      • num_customers integer
    • payments array of OrderPayment nullable
      Present only when include=payments. Null for checks still in the import buffer (the latest one or two business dates), which keeps no per-tender rows.
      Show 5 properties
      • tender_type_id string nullable
      • card_brand string nullable
      • amount number
      • tip_amount number nullable
      • paid_at string nullable
        The store-local wall clock of the payment, with no UTC offset, where the POS reports it.
  • meta object
    Show 1 property
    • data_from string (date)
• 401 Authentication failed or missing.
  • message string
• 403 The token lacks the required ability or the caller is not permitted.
  • message string
• 404 Resource not found.
  • message string
• 422 Validation failed.
  • message string
  • errors object
• 503 Order history is busy; retry after the `Retry-After` header's seconds.