Order API deliveryInfo

Jonathan Watts

April 25, 2022 21:42

I'm attempting to get an order using the Order API. The response that I'm getting has the following delivery info:

"deliveryInfo": {
    "deliveredDate": null,
    "deliveryEmployee": null,
    "deliveryState": "PENDING",
    "dispatchedDate": null
}

Based on the documentation at https://toastintegrations.redoc.ly/openapi/orders/operation/ordersGuidGet/ I was expecting address1, city, state, and zipCode to be populated since they're marked required. This seems to not always be the case.

0

• 

  Janice Manwiller

  April 26, 2022 13:43

  Does your account have the delivery_info.address:read scope? That scope is required in order to view delivery address information.

  Janice Manwiller
  Principal Technical Writer at Toast

  0
• 

  Jonathan Watts

  May 03, 2022 15:34

  I had assumed so. How would I be able to tell? It seems like we're not seeing these errors in prod so maybe it's only our sandbox account.

  0
• 

  Ann Murphy

  May 04, 2022 20:30 Edited

  Hi Jonathan, I took a look at your sandbox and production credentials. You do not have the delivery_info.address:read scope. Since this scope exposes personal information about restaurant guests, our legal team needs to approve access. If you're interested in using it, fill out this form, let us know when you do, and we'll ask our legal team to look over the request.

  0
• 

  Jonathan Watts

  May 04, 2022 16:44

  That's fine. I don't actually need this information; I had just written my code assuming it would be present. 

  0

Please sign in to leave a comment.