Inquiry Regarding Toast API Functionality

Google Play

October 21, 2024 08:11

Dear Toast Support Team,

Hello!
We are currently researching the Toast POS system, and in our anticipated use case, once a customer places an order through Toast POS, our system would retrieve the latest order, parse it, and automatically start production. Based on this expected scenario, I have a few API-related questions that I hope you can help clarify:

1. I noticed the API provides an "Add items to a check" endpoint. Could you confirm if this allows adding items to an order after it has already been created?
2. If adding items is possible, is there any other endpoint that supports removing or replacing an item within an existing order?
3. Once an order is created, is it possible to modify an item’s options? For example, if the customer initially selects “half sugar” and later wishes to change it to “no sugar,” is such a modification supported? Can this be done after payment has been made?
4. In our current use of other POS systems, during face-to-face payments, orders and payments are created almost simultaneously. To reduce response time, we usually assume the payment is successful once it’s created and immediately send the order to the production system for processing. Could you confirm if Toast POS also creates the order simultaneously when payment is initiated? Once the order is created, can we assume it is ready to be sent to our system for production?

Since modifying an order after it has been created requires re-parsing and comparing it with the local database, this adds significant complexity to our workflow. Therefore, we would greatly appreciate detailed clarification regarding how order updates are handled.

Please feel free to contact me if any part of my inquiry is unclear. I look forward to your response!

Best regards

0

• 

  John Duggan

  October 21, 2024 15:43

  Hello, 

  Thank you for your questions. Please see the answers to your questions below in 

  1. I noticed the API provides an "Add items to a check" endpoint. Could you confirm if this allows adding items to an order after it has already been created?
     1. Yes.
  2. If adding items is possible, is there any other endpoint that supports removing or replacing an item within an existing order?
     1. No, this isn’t available.
  3. Once an order is created, is it possible to modify an item’s options? For example, if the customer initially selects “half sugar” and later wishes to change it to “no sugar,” is such a modification supported? Can this be done after payment has been made?
     1. No, this can only be done manually on the POS.
  4. In our current use of other POS systems, during face-to-face payments, orders and payments are created almost simultaneously. To reduce response time, we usually assume the payment is successful once it’s created and immediately send the order to the production system for processing. Could you confirm if Toast POS also creates the order simultaneously when payment is initiated? Once the order is created, can we assume it is ready to be sent to our system for production?
     1. Anytime an order is created on the POS or Online, it'll appear on the Orders API. To ensure the order is in the CLOSED state and sent to the kitchen, you can see this by looking at the following fields in the Orders JSON via the ordersBulk endpoint or the Orders webhook. 
     2. If this is an ASAP order, Toast will update the closedDate in the Checks object when the balance due is $0 and the paymentStatus in the Payments object and Checks Object.
     3. In the Orders Object, you can check the approvalStatus object which will tell you the current state of the order in the restaurant order fulfillment process.

        1. 

     4. To see if all the items on the order were fulfilled, you can query the fulfillmentStatus field in the Selections object. This will indicate the stage of the preparation workflow that the menu item selection is in.

        1. 

  0

Please sign in to leave a comment.