{"openapi":"3.1.0","info":{"title":"ChowNow API (Bowmark)","version":"e833508f87ff","description":"ChowNow commission-free online ordering for independent restaurants: a brand's locations, a restaurant's menu and prices, pickup times, and order pricing up to the payment step.\n\nEvery function Bowmark has for ChowNow (chownow.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/chownow/findRestaurant":{"post":{"operationId":"findRestaurant","summary":"Resolves a ChowNow ordering URL (`www.chownow.com`, `order.chownow.com`, `direct.chownow.com`, `eat.chownow.com`, or the bare apex, e.g.","description":"Resolves a ChowNow ordering URL (`www.chownow.com`, `order.chownow.com`, `direct.chownow.com`, `eat.chownow.com`, or the bare apex, e.g. \"https://www.chownow.com/order/32/locations/35\") into its `companyId` and `restaurantId` — the finder every other function's id arguments come from. No network call: the ids are already in the URL's own path. Takes a link the caller already holds (from a web search, the restaurant's own site, or a prior result); to find a restaurant from words a person would say, use `searchRestaurants`.\n\nCalls `bowmark.providers.chownow.findRestaurant`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowRestaurantRef>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"TypeScript: `string`"}},"required":["url"],"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/chownow/searchRestaurants":{"post":{"operationId":"searchRestaurants","summary":"Searches ChowNow restaurants by free text (a cuisine, a dish or a restaurant name) within one city — the entry point when the caller holds only words a person would say, not a link.","description":"Searches ChowNow restaurants by free text (a cuisine, a dish or a restaurant name) within one city — the entry point when the caller holds only words a person would say, not a link. `citySlug` is lowercase and hyphenated with the two-letter state code, e.g. `\"los-angeles-ca\"`. Returns each match's `companyId`/`restaurantId` (for `listRestaurants`/`getRestaurant`), plus a cuisine breakdown for the city.\n\nCalls `bowmark.providers.chownow.searchRestaurants`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowSearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"},"citySlug":{"type":"string","description":"TypeScript: `string`"}},"required":["query","citySlug"],"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/chownow/listRestaurants":{"post":{"operationId":"listRestaurants","summary":"Lists every location a ChowNow brand operates, by `companyId` (from `findRestaurant`).","description":"Lists every location a ChowNow brand operates, by `companyId` (from `findRestaurant`). Each location carries its own `restaurantId`, name, full address with coordinates, whether it is live for ordering, and whether it currently allows ordering for right now (vs. order-ahead only).\n\nCalls `bowmark.providers.chownow.listRestaurants`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowBrand>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"string","description":"TypeScript: `string`"}},"required":["companyId"],"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/chownow/getRestaurant":{"post":{"operationId":"getRestaurant","summary":"Reads one restaurant location's own details: name, phone, address, whether it is currently live and whether it is flagged busy (orders running behind), and its pickup/delivery availability right now w","description":"Reads one restaurant location's own details: name, phone, address, whether it is currently live and whether it is flagged busy (orders running behind), and its pickup/delivery availability right now with each method's minimum lead time. `restaurantId` comes from `findRestaurant` or a `listRestaurants` row.\n\nCalls `bowmark.providers.chownow.getRestaurant`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowRestaurantDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/getPickupTimes":{"post":{"operationId":"getPickupTimes","summary":"Lists the order-ahead time slots a ChowNow restaurant offers over its coming days — the ordering page's time picker.","description":"Lists the order-ahead time slots a ChowNow restaurant offers over its coming days — the ordering page's time picker. Each day carries `pickup`, `delivery` and `curbside` lists of 15-minute slot start times (`\"HH:MM\"`, restaurant-local); an empty list means that method takes no orders that day. `restaurantId` comes from `searchRestaurants`, `findRestaurant` or a `listRestaurants` row.\n\nCalls `bowmark.providers.chownow.getPickupTimes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowPickupTimes>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/getRestaurantHours":{"post":{"operationId":"getRestaurantHours","summary":"Reads a ChowNow restaurant's operating hours for each fulfillment method (pickup, delivery, curbside) over its coming days — the days/ranges each accepts orders on — plus any announced closures.","description":"Reads a ChowNow restaurant's operating hours for each fulfillment method (pickup, delivery, curbside) over its coming days — the days/ranges each accepts orders on — plus any announced closures. A `null` method means the restaurant does not offer it at all. `restaurantId` comes from `searchRestaurants`, `findRestaurant` or a `listRestaurants` row.\n\nCalls `bowmark.providers.chownow.getRestaurantHours`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowRestaurantHours>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/getMenu":{"post":{"operationId":"getMenu","summary":"Reads a ChowNow restaurant's full menu: categories, each item's name, description and price, size pickers (`isSizePicker` items whose `sizeItemIds` are the priced sizes), and every modifier group (\"Br","description":"Reads a ChowNow restaurant's full menu: categories, each item's name, description and price, size pickers (`isSizePicker` items whose `sizeItemIds` are the priced sizes), and every modifier group (\"Bread\", \"Add-ons\") with its min/max picks and each option's price. `at` is the order time as `\"YYYYMMDDHHmm\"` in the restaurant's LOCAL time (default: the soonest time it takes orders) — the menu live at that time; a time it is closed has no menu. Returns `menuId`, the id ChowNow's order validation is keyed on.\n\nCalls `bowmark.providers.chownow.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"},"at":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/listMenuCategories":{"post":{"operationId":"listMenuCategories","summary":"Lists a ChowNow restaurant's menu category names and ids, with how many items each holds — the category list without fetching every item's detail.","description":"Lists a ChowNow restaurant's menu category names and ids, with how many items each holds — the category list without fetching every item's detail. Reads the same door as `getMenu` (same `restaurantId`/`at` arguments).\n\nCalls `bowmark.providers.chownow.listMenuCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowMenuCategorySummary[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"},"at":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/listMenuItems":{"post":{"operationId":"listMenuItems","summary":"Lists every item on a ChowNow restaurant's menu, flattened across categories, each carrying its own `categoryId`/`categoryName`.","description":"Lists every item on a ChowNow restaurant's menu, flattened across categories, each carrying its own `categoryId`/`categoryName`. Reads the same door as `getMenu` (same `restaurantId`/`at` arguments).\n\nCalls `bowmark.providers.chownow.listMenuItems`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowFlatMenuItem[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"},"at":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId"],"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/chownow/getMenuItem":{"post":{"operationId":"getMenuItem","summary":"Reads one item off a ChowNow restaurant's menu, with its modifier groups resolved to full detail (name, min/max picks, each option's price) rather than the bare ids `getMenu` returns.","description":"Reads one item off a ChowNow restaurant's menu, with its modifier groups resolved to full detail (name, min/max picks, each option's price) rather than the bare ids `getMenu` returns. `itemId` comes from `getMenu` or `listMenuItems`.\n\nCalls `bowmark.providers.chownow.getMenuItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowMenuItemDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"},"itemId":{"type":"string","description":"TypeScript: `string`"},"at":{"type":"string","description":"TypeScript: `string`"}},"required":["restaurantId","itemId"],"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/chownow/listOrders":{"post":{"operationId":"listOrders","summary":"Lists the signed-in caller's own ChowNow order history: restaurant, status, total and when it was placed.","description":"Lists the signed-in caller's own ChowNow order history: restaurant, status, total and when it was placed. The caller signs in through the relay — needs a saved ChowNow sign-in or pauses the run to get one.\n\nCalls `bowmark.providers.chownow.listOrders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowOrders>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/chownow/getOrderDetails":{"post":{"operationId":"getOrderDetails","summary":"Reads one of the signed-in caller's own ChowNow orders in full: restaurant, status, total, fulfillment method and line items.","description":"Reads one of the signed-in caller's own ChowNow orders in full: restaurant, status, total, fulfillment method and line items. `orderId` comes from a `listOrders` row. The caller signs in through the relay.\n\nCalls `bowmark.providers.chownow.getOrderDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowOrderDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["orderId"],"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/chownow/listSavedPaymentMethods":{"post":{"operationId":"listSavedPaymentMethods","summary":"Lists the signed-in caller's own saved ChowNow cards: brand, last four digits and expiry.","description":"Lists the signed-in caller's own saved ChowNow cards: brand, last four digits and expiry. Reads only; never charges. The caller signs in through the relay.\n\nCalls `bowmark.providers.chownow.listSavedPaymentMethods`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowSavedPaymentMethods>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/chownow/getRewardsBalance":{"post":{"operationId":"getRewardsBalance","summary":"Reads the signed-in caller's own ChowNow loyalty rewards points balance, any credit, and active promotions.","description":"Reads the signed-in caller's own ChowNow loyalty rewards points balance, any credit, and active promotions. The caller signs in through the relay.\n\nCalls `bowmark.providers.chownow.getRewardsBalance`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowRewardsBalance>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/chownow/validateOrder":{"post":{"operationId":"validateOrder","summary":"Prices a cart the way the ordering page itself does, before payment: fees, tax and the total, or a priced error (a minimum-order rule, an unavailable item) in `errors` — check `isValid` before trustin","description":"Prices a cart the way the ordering page itself does, before payment: fees, tax and the total, or a priced error (a minimum-order rule, an unavailable item) in `errors` — check `isValid` before trusting `total`. `menuId` is the exact value a `getMenu` call for this restaurant returned, not invented. Never submits payment; nothing is charged.\n\nCalls `bowmark.providers.chownow.validateOrder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ChownowOrderValidation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"restaurantId":{"type":"string","description":"TypeScript: `string`"},"menuId":{"type":"string","description":"TypeScript: `string`"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ChownowOrderItemInput"},"description":"TypeScript: `ChownowOrderItemInput[]`"},"options":{"type":"object","properties":{"fulfillMethod":{"anyOf":[{"const":"pickup"},{"const":"delivery"},{"const":"curbside"}]},"when":{"anyOf":[{"type":"string"},{"type":"null"}]},"specialInstructions":{"anyOf":[{"type":"string"},{"type":"null"}]},"promoCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":true,"description":"TypeScript: `{ fulfillMethod?: \"pickup\" | \"delivery\" | \"curbside\"; when?: string | null; specialInstructions?: string | null; promoCode?: string | null }`"}},"required":["restaurantId","menuId","items"],"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}}},"ChownowOrderItemInput":{"type":"object","properties":{"itemId":{"type":"string"},"quantity":{"type":"number"},"specialInstructions":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifierCategories":{"type":"array","items":{}}},"required":["itemId"],"additionalProperties":true}}}}