Create waitlist on-my-way

post

https://api.yelp.com/v3/businesses/{business_id}/waitlist/on-my-way

Create a waitlist on-my-way visit in a restaurant.

Curl example with OAuth authentication:

    root@test:~# curl -X POST https://api.yelp.com/v3/businesses/{BUSINESS_ID}/waitlist/on-my-way --header 'accept: application/json' --header "Authorization: Bearer ${API_TOKEN}" -d "{\"name\": \"Customer Name\", \"party_size\": 2, \"phone\": \"+19050000000\", \"arrival_range_max\": 30, \"arrival_range_min\": 10}""

Example 201 response:

{
    "visit_id": "Encoded visit id",
    "party_size": 2,
    "arrive_by_time": 1714577798
}

Note: In order to use this endpoint, the caller should be an onboarded Yelp Waitlist partner

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

Status	error_code	Reason
409	CONFLICT	On My Way active visit limit reached (max is currently 9 active on-my-way visits per restaurant)

Status	error_code	Reason
422	ALREADY_IN_LINE	Invalid state. For example, the phone number is already in line
422	INVALID_ETA	Expected arrival time too far in the past or future. Must be 30 minutes from now or earlier.
422	CURRENTLY_HAS_WAIT	On My Way visit creation is ineligible, there is currently a wait for the restaurant.
422	PARTY_SIZE_TOO_LARGE	Party size too large.
422	RESTAURANT_NOT_OPEN	Restaurant is not open.
422	REMOTE_ENTRY_DENIED	Restaurant does not allow remote entry.
422	SCHEDULE_CONFLICT	Special event at restaurant.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201An object contains information about the created on-my-way visit

400Bad Request. Message varies depending on failure scenario

401The API key has either expired or doesn't have the required scopes to query this endpoint. codedescriptionUNAUTHORIZED_API_KEYThe API key provided is not currently able to query this endpoint.TOKEN_INVALIDInvalid API key or authorization header.

404Resource Not Found

409This error is returned in any of the following scenarios: Statuserror_codeReason409CONFLICTOn My Way active visit limit reached (max is currently 9 active on-my-way visits per restaurant)

429You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.

500Internal Server Error

503Service Unavailable