{"openapi":"3.1.0","info":{"title":"McDonald's API (Bowmark)","version":"e833508f87ff","description":"McDonald's — the fast-food chain. Restaurant locator, national menu by category, and one item's full nutrition detail are callable now; current public deals and McDelivery availability are still stubs.\n\nEvery function Bowmark has for McDonald's (mcdonalds.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/mcdonalds/getMenu":{"post":{"operationId":"getMenu","summary":"Returns McDonald's national menu — every item's internal id, name, the category it is listed under, its product-or-meal page link, and any promo badge the site shows (e.g.","description":"Returns McDonald's national menu — every item's internal id, name, the category it is listed under, its product-or-meal page link, and any promo badge the site shows (e.g. \"Limited Time Only\"). With no `category`, returns the full grid across all 13 categories (Extra Value Meals, McValue®, Breakfast, Burgers, Chicken & Fish Sandwiches, McNuggets® & McCrispy® Strips, Snack Wrap®, Fries & Sides, Happy Meal®, Sweets & Treats, McCafé®, Drinks, Sauces & Condiments); with `category` set to one of those names, returns just that category's items off its own dedicated page. NOTE: carries no price — McDonald's publishes none on this page, national or otherwise; if a real price exists it is store-level and needs a restaurant id this function does not take. On the full grid, a few items (e.g. an Egg McMuffin® Meal) are cross-listed under two categories and appear as two rows, exactly as the site lists them. Distinct from getMenuItem, which reads one item's full nutrition detail.\n\nCalls `bowmark.providers.mcdonalds.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<mcdonaldsMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"arg0":{}},"required":["arg0"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/mcdonalds/getMenuItem":{"post":{"operationId":"getMenuItem","summary":"Returns one McDonald's menu item in full: its marketing name and description, FDA-style ingredient statement, allergen line, whether it's a multi-part meal (with a components breakdown), and the compl","description":"Returns one McDonald's menu item in full: its marketing name and description, FDA-style ingredient statement, allergen line, whether it's a multi-part meal (with a components breakdown), and the complete nutrition panel (every nutrient the site publishes, each flagged whether the site's own page currently displays it). `productId` is the SAME id `getMenu`'s items carry (e.g. \"200463\" for the Big Mac) — call getMenu first to find it, or reuse one you already have. NOTE: McDonald's publishes size/customization as SEPARATE menu items (e.g. a drink's small/medium/large are three different productIds), not as choices on one item, so this never returns a size list. Throws on an unrecognized productId naming exactly what the site said.\n\nCalls `bowmark.providers.mcdonalds.getMenuItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<mcdonaldsMenuItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"arg0":{}},"required":["arg0"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/mcdonalds/findStores":{"post":{"operationId":"findStores","summary":"Finds McDonald's restaurants near a location — pass EITHER a 5-digit US `zip` (geocoded to a centroid with a keyless third-party lookup, since mcdonalds.com's own search endpoint takes only coordinate","description":"Finds McDonald's restaurants near a location — pass EITHER a 5-digit US `zip` (geocoded to a centroid with a keyless third-party lookup, since mcdonalds.com's own search endpoint takes only coordinates) OR `latitude`+`longitude` directly, never both. Returns each restaurant's id, street address, phone, distance in miles from the search point (computed here — the site's own response carries none), open status, both the dining-room and drive-thru weekly hours exactly as published, which service modes it offers (dine-in, drive-thru, McDelivery with its delivery-partner links, mobile order & pay, kiosk audio navigation), and the site's full raw amenity list. `radiusMiles` (default 5, matching the site's own default) and `maxResults` (default 30, the site's own ceiling) bound the search the same way the site's own filter widget does. Results are sorted nearest-first. This is the gate function on this provider: getDeals and checkDeliveryAvailability's remaining `notImplemented` stubs are localized to a specific restaurant this function is what supplies (getMenu/getMenuItem are national, not restaurant-scoped).\n\nCalls `bowmark.providers.mcdonalds.findStores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<mcdonaldsFindStoresResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"arg0":{},"arg1":{}},"required":["arg0","arg1"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}