{"openapi":"3.1.0","info":{"title":"Slice API (Bowmark)","version":"e833508f87ff","description":"Slice online ordering for independent pizzerias: find the pizzerias that deliver to an address or sit in a city, a shop's menu, sizes, add-on choices, prices, hours, delivery check and fees, reviews, a priced cart up to the payment step, order tracking, and the signed-in customer's own orders, addresses and saved cards.\n\nEvery function Bowmark has for Slice (slicelife.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/slice/resolveAddress":{"post":{"operationId":"resolveAddress","summary":"Turns an address into Slice's own geocode: formatted address, coordinates, city, state and ZIP.","description":"Turns an address into Slice's own geocode: formatted address, coordinates, city, state and ZIP.\n\nCalls `bowmark.providers.slice.resolveAddress`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceLocation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string","description":"TypeScript: `string`"}},"required":["address"],"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/slice/searchPizzerias":{"post":{"operationId":"searchPizzerias","summary":"Finds the Slice pizzerias that deliver to an address (or are near it, for pickup): rating, open now, delivery fee, minimum, estimate, and the shop id and menu URL the other functions take.","description":"Finds the Slice pizzerias that deliver to an address (or are near it, for pickup): rating, open now, delivery fee, minimum, estimate, and the shop id and menu URL the other functions take. Paged.\n\nCalls `bowmark.providers.slice.searchPizzerias`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SlicePizzeriaPage & { location: SliceLocation }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchPizzeriasArgs","description":"TypeScript: `SearchPizzeriasArgs`"}},"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/slice/listPizzeriasInCity":{"post":{"operationId":"listPizzeriasInCity","summary":"Lists the Slice pizzerias in a city (\"Brooklyn\", \"NY\") with no street address needed.","description":"Lists the Slice pizzerias in a city (\"Brooklyn\", \"NY\") with no street address needed. Paged.\n\nCalls `bowmark.providers.slice.listPizzeriasInCity`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SlicePizzeriaPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListPizzeriasInCityArgs","description":"TypeScript: `ListPizzeriasInCityArgs`"}},"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/slice/getPizzeria":{"post":{"operationId":"getPizzeria","summary":"Gets one pizzeria's details from its Slice menu URL, web slug or shop id: name, address and coordinates, phone, open now for delivery and pickup, delivery and pickup estimates, minimum orders, deliver","description":"Gets one pizzeria's details from its Slice menu URL, web slug or shop id: name, address and coordinates, phone, open now for delivery and pickup, delivery and pickup estimates, minimum orders, delivery provider, service fee, whether it accepts cash and cards, cuisines and holidays.\n\nCalls `bowmark.providers.slice.getPizzeria`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SlicePizzeriaDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["pizzeria"],"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/slice/getMenu":{"post":{"operationId":"getMenu","summary":"Gets a pizzeria's full menu: categories, items with descriptions, photos and best-seller flags, and every size with its price -- the door for the item and size ids getMenuItemOptions and priceCart tak","description":"Gets a pizzeria's full menu: categories, items with descriptions, photos and best-seller flags, and every size with its price -- the door for the item and size ids getMenuItemOptions and priceCart take.\n\nCalls `bowmark.providers.slice.getMenu`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceMenu>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["pizzeria"],"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/slice/getMenuItemOptions":{"post":{"operationId":"getMenuItemOptions","summary":"Gets the choices for one menu item and size: required and optional add-on groups (sauce, cheese, toppings) with each option's price and the min/max a group allows -- what a caller must pick before pri","description":"Gets the choices for one menu item and size: required and optional add-on groups (sauce, cheese, toppings) with each option's price and the min/max a group allows -- what a caller must pick before priceCart accepts the item.\n\nCalls `bowmark.providers.slice.getMenuItemOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceAddonGroup[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"sizeId":{"type":"number","description":"TypeScript: `number`"}},"required":["pizzeria","sizeId"],"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/slice/getHours":{"post":{"operationId":"getHours","summary":"Gets when a pizzeria takes delivery and pickup orders over the coming days, as open/close windows, plus any pause it is in right now.","description":"Gets when a pizzeria takes delivery and pickup orders over the coming days, as open/close windows, plus any pause it is in right now.\n\nCalls `bowmark.providers.slice.getHours`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceSchedule>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["pizzeria"],"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/slice/checkDelivery":{"post":{"operationId":"checkDelivery","summary":"Checks whether a pizzeria delivers to an address and, if it does, the delivery fee, minimum order and whether delivery is available right now.","description":"Checks whether a pizzeria delivers to an address and, if it does, the delivery fee, minimum order and whether delivery is available right now.\n\nCalls `bowmark.providers.slice.checkDelivery`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceDeliveryCheck>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"address":{"type":"string","description":"TypeScript: `string`"}},"required":["pizzeria","address"],"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/slice/priceCart":{"post":{"operationId":"priceCart","summary":"Prices an order before checkout and returns the receipt plus every issue stopping it from being placed as it stands.","description":"Prices an order before checkout and returns the receipt plus every issue stopping it from being placed as it stands. Creates nothing and charges nothing.\n\nCalls `bowmark.providers.slice.priceCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceCartPrice>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/PriceCartArgs","description":"TypeScript: `PriceCartArgs`"}},"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/slice/validatePromoCode":{"post":{"operationId":"validatePromoCode","summary":"Checks whether a promo code works at a pizzeria for a given order, and what it takes off.","description":"Checks whether a promo code works at a pizzeria for a given order, and what it takes off.\n\nCalls `bowmark.providers.slice.validatePromoCode`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SlicePromoCodeResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"promoCode":{"type":"string","description":"TypeScript: `string`"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SliceCartItem"},"description":"TypeScript: `SliceCartItem[]`"},"shippingType":{"anyOf":[{"const":"delivery"},{"const":"pickup"}],"description":"TypeScript: `\"delivery\" | \"pickup\"`"}},"required":["pizzeria","promoCode","items","shippingType"],"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/slice/getReviews":{"post":{"operationId":"getReviews","summary":"Lists a pizzeria's customer reviews, newest first, with the overall rating and count.","description":"Lists a pizzeria's customer reviews, newest first, with the overall rating and count. Never the reviewer's email or last name.\n\nCalls `bowmark.providers.slice.getReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ reviews: SliceReview[] } & SliceRatingSummary>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["pizzeria"],"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/slice/getRecommendedAddOns":{"post":{"operationId":"getRecommendedAddOns","summary":"Gets the add-ons a pizzeria suggests for what is already in the cart (\"add garlic knots?\"), with price in dollars and the size ids priceCart takes.","description":"Gets the add-ons a pizzeria suggests for what is already in the cart (\"add garlic knots?\"), with price in dollars and the size ids priceCart takes.\n\nCalls `bowmark.providers.slice.getRecommendedAddOns`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ addOns: SliceRecommendedAddOn[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"items":{"type":"array","items":{"type":"object","properties":{"itemId":{"type":"number"},"sizeId":{"type":"number"},"quantity":{"type":"number"}},"required":["itemId","sizeId"],"additionalProperties":true},"description":"TypeScript: `{ itemId: number; sizeId: number; quantity?: number }[]`"}},"required":["pizzeria","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"}}}}}}},"/v1/sites/slice/getDeliveryEstimate":{"post":{"operationId":"getDeliveryEstimate","summary":"Gets the third-party courier's (Uber Direct and similar) delivery fee and pickup/dropoff times for an order from a pizzeria that hands delivery to one; thirdPartyCourier is false when the shop deliver","description":"Gets the third-party courier's (Uber Direct and similar) delivery fee and pickup/dropoff times for an order from a pizzeria that hands delivery to one; thirdPartyCourier is false when the shop delivers itself.\n\nCalls `bowmark.providers.slice.getDeliveryEstimate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceDeliveryEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"},"address":{"type":"string","description":"TypeScript: `string`"},"subtotal":{"type":"number","description":"TypeScript: `number`"}},"required":["pizzeria","address","subtotal"],"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/slice/getLoyaltyProgram":{"post":{"operationId":"getLoyaltyProgram","summary":"Gets a pizzeria's Slice rewards program: whether it runs one, points per dollar, and the reward milestones with the menu items each unlocks.","description":"Gets a pizzeria's Slice rewards program: whether it runs one, points per dollar, and the reward milestones with the menu items each unlocks.\n\nCalls `bowmark.providers.slice.getLoyaltyProgram`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SliceLoyaltyProgram>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"TypeScript: `string | number`"}},"required":["pizzeria"],"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}}},"ListPizzeriasInCityArgs":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"required":["city","state"],"additionalProperties":true},"PriceCartArgs":{"type":"object","properties":{"pizzeria":{"anyOf":[{"type":"string"},{"type":"number"}]},"shippingType":{"anyOf":[{"const":"delivery"},{"const":"pickup"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/SliceCartItem"}},"deliveryAddress":{"type":"string"},"tipAmount":{"type":"number"},"promoCode":{"type":"string"}},"required":["pizzeria","shippingType","items"],"additionalProperties":true},"SearchPizzeriasArgs":{"type":"object","properties":{"address":{"type":"string"},"mode":{"anyOf":[{"const":"delivery"},{"const":"pickup"}]},"sort":{"anyOf":[{"const":"recommended"},{"const":"nearby"},{"const":"rating"},{"const":"delivery_estimate"}]},"limit":{"type":"number"},"offset":{"type":"number"}},"required":["address"],"additionalProperties":true},"SliceCartItem":{"type":"object","properties":{"sizeId":{"type":"number"},"quantity":{"type":"number"},"selectionIds":{"type":"array","items":{"type":"number"}}},"required":["sizeId"],"additionalProperties":true}}}}