YEyelp
Checkout API

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
post/orders/{yelp_order_id}/confirmation_status/v3

Request

  • Base URL
    https://api.yelp.com
  • Auth
    HTTP bearer

Parameters

#/paths/~1orders~1%7Byelp_order_id%7D~1update~1v3/put/parameters/0 (unresolved $ref)

Request body

confirmation_typeobject required

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

eta_in_minutesinteger required

The estimated time of arrival.

Response

Successfully updated the order status.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.