GuidesReference Endpoints
Guides

Adding Order Details

Once the quote token is established, there are a few order-level fields that provide context for the order.

Example:

{
  "order_nubmer": "order-number-in-my-system-01",
  "currency": "USD",
  "event": {
    "name": "Awesome Event",
    "start_date": "2027-12-24",
    "start_time": "12:00",
    "end_date": "2027-12-25",
    "end_time": "16:30",
    "location": "Test Location"
  }
}

Details:

FieldTypeMax LengthDescription
order_numberstring255Reference to your order number. This provides a way to link your order to Teak's order. This must be unique per Client.
currencystring3Determine the currency for all costs and premiums that are associated with the order. Teak does not currently support multiple currencies in a single order.
eventobject-Although the event object can be set for individual items on the item level, if the event is the same for all items, it can be set on the order level. If an event is set at the order level and a different event is specified on the item level, the item level event will be associated with the item. Complete and correct event information helps customers during the claims process.
event.namestring255Name or short description of the event.
event.start_datedate-Start date of event in YYYY-MM-DD format. Start date or end date is required. (UTC)
event.start_timetime-Start time of event in hh:mm format. (UTC)
event.end_datedate-End date of event in YYYY-MM-DD format. Start date or end date is required. (UTC)
event.end_timetime-End time of event in hh:mm format. (UTC)
event.locationstring255Name or short description of event location.
📘

Event Dates & Times

Event Name & Start Date are a crucial component to an optimal consumer experience. Though these are not required, it is recommended that you pass these details in if your ticket flow is for event based purchases.

All event dates and time should be in UTC.

📘

Supported Currencies

"USD"
"CAD"
"EUR"
"GBP"
"MXN"
"AED"
"ARS"
"AUD"
"BRL"
"CHF"
"CNY"
"CZK"
"DKK"
"IDR"
"ILS"
"INR"
"JPY"
"MYR"
"NOK"
"NZD"
"NZD"
"PHP"
"SEK"
"THB"
"TRY"
"ZAR"

Todo

  • Add order_number to order request body
  • Add currency to request body
  • Add event to request body (only if applicable)