Update Order Status

This API is only for specific food partners.

This allows a status update to an order. This call returns a status code which indicates if the request was successful.

A notification will not be sent in the following scenarios:

  • The order was made over 3 hours ago
  • The same notification (same yelp_order_id and the confirmation_type) has already been sent
  • An ETA is provided and the notification is being sent past the ETA
  • An order_confirmed update is trying to be sent after a deliver_in_progress notification
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

This endpoint is part of the Checkout API, visit Checkout API to learn more.

Path Params
string
required

ID of order that Yelp will try to update.

Body Params
confirmation_type
object
required

ConfirmationType enum. The state the order is being updated to.

integer
required

The estimated time of arrival.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json