Order businessDate vs openDate

Jim Dobson

July 01, 2022 17:14 Edited

Hello,

Per Toast Order API documentation:

openedDate: string (date-time) 
The business date of the order.

businessDate: integer
The business date (yyyyMMdd) on which the order was fulfilled.

and Restaurant API documentation:

closeoutHour: integer
The hour of the day that separates one business day from the next

Additionally, I see in this post:

The businessDate populates based on order creation timing rather than payment timing.

I believe at order creation, the businessDate is based on the store's configured closeoutHour (if time is < closeoutHour, businessDate is currentDate - 1, if time is >= closeoutHour, businessDate is currentDate).

1. Can you please clarify how an order's businessDate is derived and how the closeoutHour plays a role?
2. If the order openedDate is considered the businessDate, is the openDate timestamp used to filter the Sales Summary report by hour (e.g. 7:00 AM - 8:00 PM)? If not, what time is used to filter Sales Summary by hour?

Thank you!

0

• 

  Ann Murphy

  July 06, 2022 14:43

  Hi Jim Dobson,

  The closeoutHour is the cutoff time for the restaurant’s current business day. For example, if a restaurant has the closeoutHour of 4:00 AM, and an order is placed on July 7th at 2:00 am the businessDate for that order would be July 6th. 

  The Sales Summary report is based on business date, but you can filter by hourly increments. In the attachment, you can see that when selecting “Today,” you have the option to filter until 3:59 AM because this restaurant has a 4:00 AM closeoutHour.

  

  Thanks,

  Ann

  0
• 

  Jim Dobson

  July 06, 2022 16:34

  Thank you Ann Murphy!

  And to clarify, the openedDate timestamp (converted to local time) of an Order is the time used to filter Sales Summary orders by time, correct?

  And lastly, can you please clarify the difference between openedDate (The business date of the order) being derived from the date/time the order is placed and businessDate (The business date on which the order was fulfilled).

  Thanks!

  0
• 

  Ann Murphy

  July 08, 2022 17:58

  Hi Jim Dobson,

  That is correct, the openedDate of an order is used to filter the Sales Summary report. 

  The openedDate field is the date and time the order entity was opened. In the order object this is represented by a string, and related to the business date of a restaurant, which is determined by the closeoutHour, and subsequently used to determine which date in the Sales Summary report the order will appear.

  The businessDate field in the order is the business date the order was fulfilled. The business date an order is placed (openedDate) is not necessarily the same. 

  Let me know if this clears things up!

  Ann

   

  0
• 

  Jim Dobson

  July 08, 2022 18:04

  Thank you Ann!

  0

Please sign in to leave a comment.