v1

latestOpenAPI 3.1.02026-07-248941352.6 KB
Checkout API

Get Opportunity

Get info that user provided (e.g. customer address) when they were checking if business can service them (e.g. business delivers to their address or has a reservation time slot).

The opportunity_id is provided to the Partner via the iframe URL and is the same token provided to the Partner when Yelp POSTs the user's customer address to check for delivery availability. This call is optional if the Partner temporarily caches the customer_address and opportunity token during the delivery availability check.

See Opportunity resource for more info.

get/opportunities/{opportunity_id}/v3

Path parameters

opportunity_idstring required

Unique identifier for this Opportunity

Response

Successfully retrieved the opportunity.

opportunity_idstring
partner_business_idstring
request_timeinteger
service_typestring
selected_optionstring