Type: object

root order
Type: object

root order orderKey
Type: string

root order quoteKey
Type: string

root order metadata
Type: object

This is a place to store any additional information about the order that is not covered by the other fields.

Additional Properties of any type are allowed.

root order metadata additionalProperties
Type: object

root order invoiceTarget
Type: enum (of string)

Must be one of:

  • "ORDER_SOURCE"
  • "PRODUCER_LOCATION"

root order externalId
Type: string

root order label
Type: string

root order isCash
Type: boolean Default: false

root order isPickup
Type: boolean Default: false

root order requireReadyEvent
Type: boolean

root order consumer
Type: object

root order consumer name
Type: string

root order consumer phone
Type: string

root order consumer location
Type: object

root order consumer location address1
Type: string

root order consumer location address2
Type: string

root order consumer location apartment
Type: string or null

root order consumer location city
Type: string

root order consumer location state
Type: string

root order consumer location zip
Type: stringFormat: zip-code

root order consumer location coordinates
Type: object

root order producer
Type: object

root order producer name
Type: string

root order producer phone
Type: string

root order producer producerKey
Type: string

root order producer producerLocationType
Type: enum (of string)

A STATIC location is one that has an active restaurant users and those users can interact with/manage your order. A DYNAMIC restaurant has no users associated with it.

Must be one of:

  • "STATIC"
  • "DYNAMIC"

root order price
Type: object

root order price subTotal
Type: number

Value must be greater or equal to 0

root order price tip
Type: number

Value must be greater or equal to 0

root order price tax
Type: number

Value must be greater or equal to 0

root order price relayFee
Type: number

Value must be greater or equal to 0

root order price deliveryFee
Type: number

Value must be greater or equal to 0

root order price discount
Type: number

Always treated as negative. Only useful for cash orders or reporting purposes.

root order specialInstructions
Type: string