{"openapi":"3.1.0","info":{"title":"Safeway API (Bowmark)","version":"e833508f87ff","description":"Safeway grocery (US): find a store, browse its aisles, search products with store prices and aisle locations, read the weekly ad, deals and recipes, and (signed in) manage the cart, delivery and pickup windows, orders, past purchases, shopping list, coupons and rewards. Never checks out.\n\nEvery function Bowmark has for Safeway (safeway.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/safeway/findStores":{"post":{"operationId":"findStores","summary":"Finds Safeway stores near a ZIP code: store id, address, distance, timezone and whether each offers Drive Up & Go pickup or is the single store the gateway names as nearest for delivery.","description":"Finds Safeway stores near a ZIP code: store id, address, distance, timezone and whether each offers Drive Up & Go pickup or is the single store the gateway names as nearest for delivery. The door every other store-scoped function's `storeId` comes from. THROWS rather than returning [] when the gateway answers without its store list — see findStores.ts's header on why an absent list must not read as an honest empty one.\n\nCalls `bowmark.providers.safeway.findStores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<FindStoresResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"zipcode":{"type":"string"},"radiusMiles":{"type":"number"},"limit":{"type":"number"}},"required":["zipcode"],"additionalProperties":true,"description":"TypeScript: `{ zipcode: string; radiusMiles?: number; limit?: number }`"}},"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/safeway/getStore":{"post":{"operationId":"getStore","summary":"Returns one Safeway store by id (from findStores): address, the rewards-program delivery/pickup flags, and its own SERVICE departments (Floral, Deli, …) with their weekly hours.","description":"Returns one Safeway store by id (from findStores): address, the rewards-program delivery/pickup flags, and its own SERVICE departments (Floral, Deli, …) with their weekly hours. Does NOT carry a phone number or a single storefront open/close pair — the door answers neither; see getStore.ts's header.\n\nCalls `bowmark.providers.safeway.getStore`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SafewayStoreDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"storeId":{"type":"string"}},"required":["storeId"],"additionalProperties":true,"description":"TypeScript: `{ storeId: string }`"}},"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/safeway/listAisles":{"post":{"operationId":"listAisles","summary":"Lists Safeway's grocery departments and the aisles inside each, with the slug listAisleProducts takes.","description":"Lists Safeway's grocery departments and the aisles inside each, with the slug listAisleProducts takes. Read off the homepage's own 'Shop by Category' nav, not a store-scoped door, so it carries whatever that nav rendered on the call — see listAisles.ts's header on the one department that can come back as an inline load error.\n\nCalls `bowmark.providers.safeway.listAisles`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SafewayDepartment[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"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/safeway/listAisleProducts":{"post":{"operationId":"listAisleProducts","summary":"Lists the products in one aisle at one store — name, productId (what getProduct takes) and the product's own url.","description":"Lists the products in one aisle at one store — name, productId (what getProduct takes) and the product's own url. Read off the aisle page's server-rendered grid (not the /shop/aisles/<dept>/<aisle>.html nav page listAisles reads). Does NOT carry price, member price, unit price, stock or the in-store aisle location — none of that is in this door's markup; see listAisleProducts.ts's header.\n\nCalls `bowmark.providers.safeway.listAisleProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ListAisleProductsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"department":{"type":"string"},"aisle":{"type":"string"},"storeId":{"type":"string"},"page":{"type":"number"}},"required":["department","aisle","storeId"],"additionalProperties":true,"description":"TypeScript: `{ department: string; aisle: string; storeId: string; page?: number }`"}},"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/safeway/getSearchSuggestions":{"post":{"operationId":"getSearchSuggestions","summary":"Returns Safeway's type-ahead suggestions for a partial query, each with the department and brands the first suggestion narrows to.","description":"Returns Safeway's type-ahead suggestions for a partial query, each with the department and brands the first suggestion narrows to. Does NOT return product rows — see getSearchSuggestions.ts's header for the door it reads and how it differs from the still-blocked searchProducts.\n\nCalls `bowmark.providers.safeway.getSearchSuggestions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GetSearchSuggestionsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"object","properties":{"query":{"type":"string"},"storeId":{"type":"string"}},"required":["query"],"additionalProperties":true},{"type":"string"}],"description":"TypeScript: `{ query: string; storeId?: string } | string`"}},"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/safeway/getWeeklyAd":{"post":{"operationId":"getWeeklyAd","summary":"Returns the one flagship weekly-ad flyer live at a store: its own valid dates, PDF, and every item on it with its sale price as printed.","description":"Returns the one flagship weekly-ad flyer live at a store: its own valid dates, PDF, and every item on it with its sale price as printed. Read through Flipp, the flyer platform behind this page (not the XAPI gateway) — see getWeeklyAd.ts's header and _flipp.ts.\n\nCalls `bowmark.providers.safeway.getWeeklyAd`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<GetWeeklyAdResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"storeId":{"type":"string"},"zipcode":{"type":"string"}},"required":["storeId","zipcode"],"additionalProperties":true,"description":"TypeScript: `{ storeId: string; zipcode: string }`"}},"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/safeway/listDeals":{"post":{"operationId":"listDeals","summary":"Lists every deal across EVERY live flyer at a store (the weekly ad plus any other concurrent promo flyer), each tagged with which flyer it came from — the broader sibling of getWeeklyAd.","description":"Lists every deal across EVERY live flyer at a store (the weekly ad plus any other concurrent promo flyer), each tagged with which flyer it came from — the broader sibling of getWeeklyAd. Read through the same Flipp doors; see listDeals.ts's header.\n\nCalls `bowmark.providers.safeway.listDeals`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ListDealsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"storeId":{"type":"string"},"zipcode":{"type":"string"}},"required":["storeId","zipcode"],"additionalProperties":true,"description":"TypeScript: `{ storeId: string; zipcode: string }`"}},"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/safeway/searchRecipes":{"post":{"operationId":"searchRecipes","summary":"Searches Safeway's recipes by meaning (the site's own semantic search, so the nearest recipes come back even when none literally match) or lists one cookbook by slug.","description":"Searches Safeway's recipes by meaning (the site's own semantic search, so the nearest recipes come back even when none literally match) or lists one cookbook by slug. Each row carries the slug getRecipe takes, time, servings, calories and the ingredient basket's price in cents. See recipes.ts's header.\n\nCalls `bowmark.providers.safeway.searchRecipes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SearchRecipesResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"$ref":"#/components/schemas/SearchRecipesArgs"},{"type":"string"}],"description":"TypeScript: `SearchRecipesArgs | string`"}},"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/safeway/getRecipe":{"post":{"operationId":"getRecipe","summary":"Returns one Safeway recipe by slug (from searchRecipes) or url: ingredients with the Safeway product matched to each (productId, UPC, price in cents), steps, time, servings, diets, cookware and per-se","description":"Returns one Safeway recipe by slug (from searchRecipes) or url: ingredients with the Safeway product matched to each (productId, UPC, price in cents), steps, time, servings, diets, cookware and per-serving nutrition. Product prices are for the recipe page's own default store, named in storeId.\n\nCalls `bowmark.providers.safeway.getRecipe`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SafewayRecipe>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"$ref":"#/components/schemas/GetRecipeArgs"},{"type":"string"}],"description":"TypeScript: `GetRecipeArgs | string`"}},"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/safeway/getMyAccount":{"post":{"operationId":"getMyAccount","summary":"Returns the signed-in caller's own Safeway profile (needs the caller signed in): name, email, phone, preferred store and Safeway for U loyalty id.","description":"Returns the signed-in caller's own Safeway profile (needs the caller signed in): name, email, phone, preferred store and Safeway for U loyalty id. See getMyAccount.ts's header for the door and its measured refusal.\n\nCalls `bowmark.providers.safeway.getMyAccount`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SafewayAccount>`.","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/safeway/getCart":{"post":{"operationId":"getCart","summary":"Returns the signed-in caller's own Safeway cart (needs the caller signed in): cart id, store, subtotal and each item's product id, name, quantity and price.","description":"Returns the signed-in caller's own Safeway cart (needs the caller signed in): cart id, store, subtotal and each item's product id, name, quantity and price. See getCart.ts's header for the door and its measured refusal.\n\nCalls `bowmark.providers.safeway.getCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SafewayCart>`.","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/safeway/addToCart":{"post":{"operationId":"addToCart","summary":"Adds a product to the signed-in caller's own Safeway cart at a store (needs the caller signed in).","description":"Adds a product to the signed-in caller's own Safeway cart at a store (needs the caller signed in). Never checks out. See addToCart.ts's header for the door and its measured refusal.\n\nCalls `bowmark.providers.safeway.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AddToCartResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/AddToCartArgs","description":"TypeScript: `AddToCartArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/safeway/updateCartItem":{"post":{"operationId":"updateCartItem","summary":"Sets the quantity of a product in the signed-in caller's own Safeway cart (needs the caller signed in).","description":"Sets the quantity of a product in the signed-in caller's own Safeway cart (needs the caller signed in). Never checks out. See cartEdits.ts's header.\n\nCalls `bowmark.providers.safeway.updateCartItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<UpdateCartItemResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/UpdateCartItemArgs","description":"TypeScript: `UpdateCartItemArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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/safeway/removeFromCart":{"post":{"operationId":"removeFromCart","summary":"Removes a product from the signed-in caller's own Safeway cart (needs the caller signed in).","description":"Removes a product from the signed-in caller's own Safeway cart (needs the caller signed in). See cartEdits.ts's header.\n\nCalls `bowmark.providers.safeway.removeFromCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<RemoveFromCartResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/RemoveFromCartArgs","description":"TypeScript: `RemoveFromCartArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"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}}},"AddToCartArgs":{"type":"object","properties":{"productId":{"type":"string"},"storeId":{"type":"string"},"quantity":{"type":"number"},"zipCode":{"type":"string"},"fulfillment":{"anyOf":[{"const":"delivery"},{"const":"pickup"}]}},"required":["productId","storeId"],"additionalProperties":true},"GetRecipeArgs":{"type":"object","properties":{"slug":{"type":"string"}},"required":["slug"],"additionalProperties":true},"RemoveFromCartArgs":{"type":"object","properties":{"productId":{"type":"string"},"storeId":{"type":"string"},"zipCode":{"type":"string"},"fulfillment":{"anyOf":[{"const":"delivery"},{"const":"pickup"}]}},"required":["productId","storeId"],"additionalProperties":true},"SearchRecipesArgs":{"type":"object","properties":{"query":{"type":"string"},"cookbook":{"type":"string"},"storeId":{"type":"string"},"limit":{"type":"number"}},"additionalProperties":true},"UpdateCartItemArgs":{"type":"object","properties":{"productId":{"type":"string"},"storeId":{"type":"string"},"quantity":{"type":"number"},"zipCode":{"type":"string"},"fulfillment":{"anyOf":[{"const":"delivery"},{"const":"pickup"}]}},"required":["productId","storeId","quantity"],"additionalProperties":true}}}}