Yelp · OpenAPI Overlay 1.0.0

Yelp Checkout API overlay

9 actions 9 updates update extends openapi/yelp-checkout-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Yelp's API. It is a proposal applied on top of the contract, not a document Yelp publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-hintsx-apievangelist

Targets 9

$.info

$.paths['/opportunities/{opportunity_id}/v3'].get

$.paths['/orders/create/v3'].post

$.paths['/orders/{yelp_order_id}/cancel/v3'].post

$.paths['/orders/{yelp_order_id}/confirmation_status/v3'].post

$.paths['/orders/{yelp_order_id}/notifications/v3'].get

$.paths['/orders/{yelp_order_id}/status/v3'].get

$.paths['/orders/{yelp_order_id}/update/v3'].put

$.paths['/orders/{yelp_order_id}/user_info/v3'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: Yelp Checkout API overlay
  version: 1.0.0
extends: openapi/yelp-checkout-api-openapi.yml
x-provenance:
  generated: '2026-11-05'
  method: generated
  source: openapi/yelp-checkout-api-openapi.yml
actions:
- target: $.info
  description: Record API Evangelist provenance for this contract.
  update:
    x-apievangelist:
      provider: yelp
      profiled: '2026-11-05'
      source_file: openapi/yelp-checkout-api-openapi.yml
      mcp_server: https://github.com/Yelp/yelp-mcp
- target: $.paths['/opportunities/{opportunity_id}/v3'].get
  description: Agent hints for get_opportunity derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: true
      destructive: false
- target: $.paths['/orders/create/v3'].post
  description: Agent hints for create_order derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/cancel/v3'].post
  description: Agent hints for cancel_order derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/confirmation_status/v3'].post
  description: Agent hints for update_order_status derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/notifications/v3'].get
  description: Agent hints for get_status_change_notifications derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: true
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/status/v3'].get
  description: Agent hints for get_order_status derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: true
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/update/v3'].put
  description: Agent hints for update_order derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
- target: $.paths['/orders/{yelp_order_id}/user_info/v3'].get
  description: Agent hints for get_user_fulfillment_info derived from the HTTP method.
  update:
    x-agent-hints:
      readOnly: true
      destructive: false

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/yelp-checkout-api-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.