{"openapi":"3.1.0","info":{"title":"Olo API (Bowmark)","version":"e833508f87ff","description":"Olo-hosted restaurant order sites (order.fazolis.com, order.portillos.com, order.wingstop.com and every other chain on Olo Serve): find a location, read its menu and prices, list pickup days and times, and build a guest order up to the payment step.\n\nEvery function Bowmark has for Olo (olo.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/olo/findBrand":{"post":{"operationId":"findBrand","summary":"Finds the Olo order site for a restaurant chain from an order-site link, the chain's own website, or its name, and returns the order host, channel slug, brand name, handoff modes, advance-order window","description":"Finds the Olo order site for a restaurant chain from an order-site link, the chain's own website, or its name, and returns the order host, channel slug, brand name, handoff modes, advance-order window, and login provider. Example: `bowmark.providers.olo.findBrand({ chain: \"order.fazolis.com\" })`.\n\nCalls `bowmark.providers.olo.findBrand`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBrand>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloFindBrandArgs","description":"TypeScript: `OloFindBrandArgs`"}},"required":["args"],"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/olo/listRegions":{"post":{"operationId":"listRegions","summary":"Lists the states where a chain (its order-site host, from findBrand) has Olo-ordering locations.","description":"Lists the states where a chain (its order-site host, from findBrand) has Olo-ordering locations. Example: `bowmark.providers.olo.listRegions(\"order.fazolis.com\")`.\n\nCalls `bowmark.providers.olo.listRegions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloRegion[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host":{"type":"string","description":"TypeScript: `string`"}},"required":["host"],"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/olo/searchLocations":{"post":{"operationId":"searchLocations","summary":"Searches a chain's locations near an address, a lat/lng, or across a whole state, returning each location's id, slug, address, phone, hours and whether it is accepting online orders now.","description":"Searches a chain's locations near an address, a lat/lng, or across a whole state, returning each location's id, slug, address, phone, hours and whether it is accepting online orders now. Example: `bowmark.providers.olo.searchLocations({ host: \"order.fazolis.com\", address: \"Abilene, TX\" })`.\n\nCalls `bowmark.providers.olo.searchLocations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloLocationSummary[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloSearchLocationsArgs","description":"TypeScript: `OloSearchLocationsArgs`"}},"required":["args"],"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/olo/getLocation":{"post":{"operationId":"getLocation","summary":"Returns one location's details: address, coordinates, phone, open-now status, whether it accepts advance orders, its tax rate and the handoff modes it supports.","description":"Returns one location's details: address, coordinates, phone, open-now status, whether it accepts advance orders, its tax rate and the handoff modes it supports. Example: `bowmark.providers.olo.getLocation({ host: \"order.fazolis.com\", slug: \"abilene-tx\" })`.\n\nCalls `bowmark.providers.olo.getLocation`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloLocationDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloLocationArgs","description":"TypeScript: `OloLocationArgs`"}},"required":["args"],"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/olo/getMenu":{"post":{"operationId":"getMenu","summary":"Returns a location's menu: categories in order, and each product's id, name, description, price (resolved from its option groups when the chain prices it that way, rather than reporting 0) and the opt","description":"Returns a location's menu: categories in order, and each product's id, name, description, price (resolved from its option groups when the chain prices it that way, rather than reporting 0) and the option-group ids that customise it. Example: `bowmark.providers.olo.getMenu({ host: \"order.fazolis.com\", slug: \"abilene-tx\" })`.\n\nCalls `bowmark.providers.olo.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloGetMenuArgs","description":"TypeScript: `OloGetMenuArgs`"}},"required":["args"],"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/olo/getProductOptions":{"post":{"operationId":"getProductOptions","summary":"Returns the customisation tree for a product's option groups -- whether each is mandatory and each choice's id, name and price difference, with any nested option groups a choice reveals.","description":"Returns the customisation tree for a product's option groups -- whether each is mandatory and each choice's id, name and price difference, with any nested option groups a choice reveals. Needs a vendor id (from getLocation or getMenu) and option-group ids off a getMenu product.\n\nCalls `bowmark.providers.olo.getProductOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloOptionGroup[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloGetProductOptionsArgs","description":"TypeScript: `OloGetProductOptionsArgs`"}},"required":["args"],"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/olo/listOrderDays":{"post":{"operationId":"listOrderDays","summary":"Lists the days (today through the chain's advance-order window) a location will take an order for a handoff mode, as ISO dates.","description":"Lists the days (today through the chain's advance-order window) a location will take an order for a handoff mode, as ISO dates. Needs a vendor id from getLocation or getMenu.\n\nCalls `bowmark.providers.olo.listOrderDays`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<string[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloListOrderDaysArgs","description":"TypeScript: `OloListOrderDaysArgs`"}},"required":["args"],"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/olo/listTimeSlots":{"post":{"operationId":"listTimeSlots","summary":"Lists the pickup or delivery time slots a location offers on one day, for a handoff mode, as UTC instants.","description":"Lists the pickup or delivery time slots a location offers on one day, for a handoff mode, as UTC instants. Needs a vendorId and a date from listOrderDays. Example: `bowmark.providers.olo.listTimeSlots({ host: \"order.fazolis.com\", vendorId: 81322, date: \"2026-10-30\" })`.\n\nCalls `bowmark.providers.olo.listTimeSlots`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloTimeSlot[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloListTimeSlotsArgs","description":"TypeScript: `OloListTimeSlotsArgs`"}},"required":["args"],"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/olo/checkOrderAvailability":{"post":{"operationId":"checkOrderAvailability","summary":"Checks whether a location can take an order right now or at a chosen time for a handoff mode (and, for delivery, whether it covers an address), and when it next opens if not.","description":"Checks whether a location can take an order right now or at a chosen time for a handoff mode (and, for delivery, whether it covers an address), and when it next opens if not. Defaults to checking right now.\n\nCalls `bowmark.providers.olo.checkOrderAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloOrderAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloCheckOrderAvailabilityArgs","description":"TypeScript: `OloCheckOrderAvailabilityArgs`"}},"required":["args"],"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/olo/startOrder":{"post":{"operationId":"startOrder","summary":"Opens a guest basket at a location, returning the basket guid every other basket call (addToBasket, getBasket) needs.","description":"Opens a guest basket at a location, returning the basket guid every other basket call (addToBasket, getBasket) needs. Private to this call -- nothing is charged, and the basket only exists for the rest of the script. The handoff mode and time wanted are set later, with setHandoff. Example: `bowmark.providers.olo.startOrder({ host: \"order.fazolis.com\", vendorId: 81322 })`.\n\nCalls `bowmark.providers.olo.startOrder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloStartOrderArgs","description":"TypeScript: `OloStartOrderArgs`"}},"required":["args"],"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/olo/addToBasket":{"post":{"operationId":"addToBasket","summary":"Adds a product to a guest basket from startOrder, with a quantity and any option choices, and returns the updated basket with its running subtotal, tax and total.","description":"Adds a product to a guest basket from startOrder, with a quantity and any option choices, and returns the updated basket with its running subtotal, tax and total.\n\nCalls `bowmark.providers.olo.addToBasket`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloAddToBasketArgs","description":"TypeScript: `OloAddToBasketArgs`"}},"required":["args"],"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/olo/getBasket":{"post":{"operationId":"getBasket","summary":"Returns a guest basket's current items, subtotal, tax and total.","description":"Returns a guest basket's current items, subtotal, tax and total.\n\nCalls `bowmark.providers.olo.getBasket`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloGetBasketArgs","description":"TypeScript: `OloGetBasketArgs`"}},"required":["args"],"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/olo/updateBasketItem":{"post":{"operationId":"updateBasketItem","summary":"Changes a basket item's quantity, options or instructions, by the item's id off getBasket, and returns the updated basket with its new subtotal, tax and total.","description":"Changes a basket item's quantity, options or instructions, by the item's id off getBasket, and returns the updated basket with its new subtotal, tax and total.\n\nCalls `bowmark.providers.olo.updateBasketItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloUpdateBasketItemArgs","description":"TypeScript: `OloUpdateBasketItemArgs`"}},"required":["args"],"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/olo/removeBasketItem":{"post":{"operationId":"removeBasketItem","summary":"Removes an item from a guest basket, by the item's id off getBasket, and returns the basket that is left.","description":"Removes an item from a guest basket, by the item's id off getBasket, and returns the basket that is left.\n\nCalls `bowmark.providers.olo.removeBasketItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloRemoveBasketItemArgs","description":"TypeScript: `OloRemoveBasketItemArgs`"}},"required":["args"],"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/olo/applyCoupon":{"post":{"operationId":"applyCoupon","summary":"Applies a coupon or promo code to a guest basket, or removes it by omitting the code, and returns the updated basket with its couponDiscount.","description":"Applies a coupon or promo code to a guest basket, or removes it by omitting the code, and returns the updated basket with its couponDiscount.\n\nCalls `bowmark.providers.olo.applyCoupon`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloBasket>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloApplyCouponArgs","description":"TypeScript: `OloApplyCouponArgs`"}},"required":["args"],"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/olo/setHandoff":{"post":{"operationId":"setHandoff","summary":"Sets how and when a guest basket is picked up (carryout, drive-thru, curbside, delivery; ASAP or a time slot), then runs the site's own checkout validation and returns the basket with readyForCheckout","description":"Sets how and when a guest basket is picked up (carryout, drive-thru, curbside, delivery; ASAP or a time slot), then runs the site's own checkout validation and returns the basket with readyForCheckout.\n\nCalls `bowmark.providers.olo.setHandoff`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloHandoffResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloSetHandoffArgs","description":"TypeScript: `OloSetHandoffArgs`"}},"required":["args"],"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/olo/startCheckout":{"post":{"operationId":"startCheckout","summary":"Takes a guest basket (products added, setHandoff run) to the payment step: runs the site's checkout validation and returns the final total, handoff, accepted payment methods and the checkout page URL.","description":"Takes a guest basket (products added, setHandoff run) to the payment step: runs the site's checkout validation and returns the final total, handoff, accepted payment methods and the checkout page URL. It never pays.\n\nCalls `bowmark.providers.olo.startCheckout`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloCheckout>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloStartCheckoutArgs","description":"TypeScript: `OloStartCheckoutArgs`"}},"required":["args"],"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/olo/getOrderStatus":{"post":{"operationId":"getOrderStatus","summary":"Returns a placed order's status from its order id (off the confirmation link): status, items, total and pickup time.","description":"Returns a placed order's status from its order id (off the confirmation link): status, items, total and pickup time.\n\nCalls `bowmark.providers.olo.getOrderStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<OloOrderStatus>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/OloGetOrderStatusArgs","description":"TypeScript: `OloGetOrderStatusArgs`"}},"required":["args"],"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}}},"OloAddToBasketArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"},"vendorId":{"type":"number"},"vendorProductId":{"type":"number"},"quantity":{"type":"number"},"choiceIds":{"type":"array","items":{"type":"number"}},"specialInstructions":{"type":"string"},"recipientName":{"type":"string"}},"required":["host","guid","vendorId","vendorProductId","quantity"],"additionalProperties":true},"OloApplyCouponArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["host","guid"],"additionalProperties":true},"OloCheckOrderAvailabilityArgs":{"type":"object","properties":{"host":{"type":"string"},"vendorId":{"type":"number"},"handoffMode":{"type":"string"},"timeWantedType":{"anyOf":[{"const":"Immediate"},{"const":"Advance"}]},"timeWanted":{"type":"string"},"address":{"type":"string"}},"required":["host","vendorId"],"additionalProperties":true},"OloFindBrandArgs":{"type":"object","properties":{"chain":{"type":"string"}},"required":["chain"],"additionalProperties":true},"OloGetBasketArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"}},"required":["host","guid"],"additionalProperties":true},"OloGetMenuArgs":{"type":"object","properties":{"host":{"type":"string"},"slug":{"type":"string"},"handoffMode":{"type":"string"}},"required":["host","slug"],"additionalProperties":true},"OloGetOrderStatusArgs":{"type":"object","properties":{"host":{"type":"string"},"orderId":{"type":"string"}},"required":["host","orderId"],"additionalProperties":true},"OloGetProductOptionsArgs":{"type":"object","properties":{"host":{"type":"string"},"vendorId":{"type":"number"},"optionGroupIds":{"type":"array","items":{"type":"number"}},"handoffMode":{"type":"string"}},"required":["host","vendorId","optionGroupIds"],"additionalProperties":true},"OloListOrderDaysArgs":{"type":"object","properties":{"host":{"type":"string"},"vendorId":{"type":"number"},"handoffMode":{"type":"string"}},"required":["host","vendorId"],"additionalProperties":true},"OloListTimeSlotsArgs":{"type":"object","properties":{"host":{"type":"string"},"vendorId":{"type":"number"},"date":{"type":"string"},"handoffMode":{"type":"string"}},"required":["host","vendorId","date"],"additionalProperties":true},"OloLocationArgs":{"type":"object","properties":{"host":{"type":"string"},"slug":{"type":"string"},"handoffMode":{"type":"string"}},"required":["host","slug"],"additionalProperties":true},"OloRemoveBasketItemArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"},"basketProductId":{"type":"string"}},"required":["host","guid","basketProductId"],"additionalProperties":true},"OloSearchLocationsArgs":{"type":"object","properties":{"host":{"type":"string"},"address":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"regionCode":{"type":"string"},"handoffMode":{"type":"string"}},"required":["host"],"additionalProperties":true},"OloSetHandoffArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"},"vendorId":{"type":"number"},"handoffMode":{"type":"string"},"timeWantedType":{"anyOf":[{"const":"Immediate"},{"const":"Advance"}]},"timeWanted":{"type":"string"},"address":{"type":"string"}},"required":["host","guid","vendorId"],"additionalProperties":true},"OloStartCheckoutArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"}},"required":["host","guid"],"additionalProperties":true},"OloStartOrderArgs":{"type":"object","properties":{"host":{"type":"string"},"vendorId":{"type":"number"}},"required":["host","vendorId"],"additionalProperties":true},"OloUpdateBasketItemArgs":{"type":"object","properties":{"host":{"type":"string"},"guid":{"type":"string"},"basketProductId":{"type":"string"},"vendorId":{"type":"number"},"vendorProductId":{"type":"number"},"quantity":{"type":"number"},"choiceIds":{"type":"array","items":{"type":"number"}},"specialInstructions":{"type":"string"},"recipientName":{"type":"string"}},"required":["host","guid","basketProductId","vendorId","vendorProductId","quantity"],"additionalProperties":true}}}}