Skip to main content

Toast API

Answered
Jim Dobson
Edited

I have the following questions regarding Toast APIs

Orders API

  • When calling /orders/v2/ordersBulk endpoint for a specific store with startDate(time) and endDate(time) parameters, and both dates are  in the past with no orders returned (empty array), can it be assumed no orders will ever be returned in the future if the same startDate and endDate parameters are used?

  • Is there a max time span allowed between startDate and endDate? (a consideration for loading historical data)

  • Are the orders returned from /ordersBulk endpoint ordered by Modified Date. If not, what is the order by?

  • Is the /ordersBulk endpoint request rate limits 20/sec and 10000/15 mins?

  • Are order object dateTime fields (e.g. openedDate, modifiedDate, etc.) in UTC or store/local time?

  • Is there any delay between when an order is posted (new/modified orders) and order retrieval (orders via GET /ordersBulk endpoint)?

  • Regarding Checks, are the amount fields relative to the check only? Are there any Check amount fields relative to the Order?

  • Modifiers property (Order/Check/Selection/Modifiers) is a list of Selection objects. Is there a limit on how deep modifiers can recurse?

 

Restaurants API

  • Is there an endpoint (or plans for an endpoint) to return a restaurant based on a lastModified date (similar to Configurations API endpoints)?

 

Configurations API

  • Are all Menu Items exposed in menus returned by the Menus API V2 /menus endpoint the menu items returned from Configurations API /menuItems endpoint?
0

Comments

1 comment

Date Votes
  • Liz Jackson

    Hi Jim Dobson,

    Answers below!

    Orders API

    • When calling /orders/v2/ordersBulk endpoint for a specific store with startDate(time) and endDate(time) parameters, and both dates are  in the past with no orders returned (empty array), can it be assumed no orders will ever be returned in the future if the same startDate and endDate parameters are used?
      That is a correct assumption as long as startDate and endDate are both in the past. Since your orders API call indicated that no orders' most recent modified timestamp was the range you specified, no orders' most recent modified timestamp will ever be in that range.

    • Is there a max time span allowed between startDate and endDate? (a consideration for loading historical data)
      There is not. The endpoint is paginated so it can handle order queries spanning large time intervals.

    • Are the orders returned from /ordersBulk endpoint ordered by Modified Date. If not, what is the order by?
      Not actually sure – I will look into this next week.

    • Is the /ordersBulk endpoint request rate limits 20/sec and 10000/15 mins?
      It is not. The orders bulk rate limit is 5 requests per location per second (more info here and here), though we recommend staying under this limit if possible. Before you roll out orders bulk usage in production, let us know your desired call volume so we can consider this from a load perspective.

    • Are order object dateTime fields (e.g. openedDate, modifiedDate, etc.) in UTC or store/local time?
      They are in UTC, more info here.

    • Is there any delay between when an order is posted (new/modified orders) and order retrieval (orders via GET /ordersBulk endpoint)?
      Maybe a fraction of a second, but no meaningful delay from a user perspective.

    • Regarding Checks, are the amount fields relative to the check only? Are there any Check amount fields relative to the Order?
      Not sure I understand the question - mind giving an example?

    • Modifiers property (Order/Check/Selection/Modifiers) is a list of Selection objects. Is there a limit on how deep modifiers can recurse?
      There is not a limit. In practice, our menu setup staff typically recommend no more than ~2 levels of modifier nesting for ease of restaurant staff workflows, but from a theoretical perspective, there is not a modifier recursion limit.

     

    Restaurants API

    • Is there an endpoint (or plans for an endpoint) to return a restaurant based on a lastModified date (similar to Configurations API endpoints)?
      There is not. Can you provide more info about the use case you have in mind? This will help us understand if there is any existing API info that could help.

     

    Configurations API

    • Are all Menu Items exposed in menus returned by the Menus API V2 /menus endpoint the menu items returned from Configurations API /menuItems endpoint?
      The /menuItems endpoint of the config API may return more items than the menus API. The menus API returns a fully resolved menu JSON, meaning that menu items will only appear in the JSON if they have a parent menu group and this menu group has a parent menu. The config API returns all valid items, including "orphaned" items that were removed from their menu group and are therefore not visible on the POS or elsewhere.

    Let us know if you have additional questions.

    0

Please sign in to leave a comment.

Didn't find what you were looking for?

New post