Order source property value

Answered

Jim Dobson

February 21, 2022 21:54 Edited

The Order API doc indicates the order source property will contain one of the following values:

• In Store
• Online
• OPT
• API
• Kiosk
• Caller Id
• Google
• Invoice

In our sandbox, which has a lot of order data (although somewhat stale data from 2019 and 2020), I see many orders contain a source value of "Toast Pickup App". 

Is this a deprecated order source or does the order doc need to be updated? If this is a deprecated order source, are there other order sources that have been deprecated that should be considered when retrieving historic order data from the Order API?

0

• 

  Ann Murphy

  February 23, 2022 21:54

  Hi Jim,

  "Toast Pickup App" is actually a new order source value, not a deprecated one. Our APIs associate these string values at the time of the request, which is why you are seeing it for historic data. Thank you so much for pointing this out. We will update our developer guide to properly reflect the new value.

  Thanks!

  0
• 

  Jim Dobson

  February 24, 2022 14:41

  Thanks Ann. Most of the order sources are self explanatory by name except OPT, can you please describe this one for me or point me to more detailed documentation for order source?

  Thanks

  0
• 

  Ann Murphy

  February 24, 2022 15:51

  OPT is Toast Order & Pay at the Table. More info about this service can be found on Toast Central. The Order & Pay™️ at the Table FAQ article has a lot of useful information.

  0
• 

  Ann Murphy

  February 25, 2022 20:49

  Hi Jim,

  While doing additional investigation on this topic, we noticed that the Orders API doc should actually display the string value "Order-and-Pay-at-Table," not OPT for this order source. We will be updating our documentation to properly reflect this. Apologies for any confusion. 

  Thanks!

  0
• 

  Jim Dobson

  February 25, 2022 21:38

  Thanks Ann. And to clarify, it will be hyphenated? Asking because no other multi-word values are (In Store, Toast Pickup App, Caller Id).

  0
• 

  Ann Murphy

  February 28, 2022 17:37

  Hi Jim, yes it will be hyphenated. 

  0

Please sign in to leave a comment.