{"openapi":"3.1.0","info":{"title":"IKEA API (Bowmark)","version":"e833508f87ff","description":"IKEA's US store: search the catalogue, read a product's price, dimensions and assembly PDFs, check stock at each store, find stores, and manage a cart; with the caller signed in, read their purchases and IKEA Family offers.\n\nEvery function Bowmark has for IKEA (ikea.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/ikea/searchProducts":{"post":{"operationId":"searchProducts","summary":"Searches IKEA's US catalogue by keyword and returns each product's item number, name, type, price, rating, colour variants and product-page URL.","description":"Searches IKEA's US catalogue by keyword and returns each product's item number, name, type, price, rating, colour variants and product-page URL.\n\nCalls `bowmark.providers.ikea.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaSearchProduct[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchProductsArgs","description":"TypeScript: `SearchProductsArgs`"}},"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/ikea/suggestSearchTerms":{"post":{"operationId":"suggestSearchTerms","summary":"Returns IKEA's own search-as-you-type suggestions for a partial query (e.g.","description":"Returns IKEA's own search-as-you-type suggestions for a partial query (e.g. 'sof' → 'sofa bed', 'sofa sleeper') plus the categories it offers for it, so a caller can find the name IKEA files a product under.\n\nCalls `bowmark.providers.ikea.suggestSearchTerms`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaSearchSuggestions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SuggestSearchTermsArgs","description":"TypeScript: `SuggestSearchTermsArgs`"}},"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/ikea/getProduct":{"post":{"operationId":"getProduct","summary":"Reads one product page by item number or URL: name, price, description, dimensions, colour, materials, care instructions, package count and weight, rating and images.","description":"Reads one product page by item number or URL: name, price, description, dimensions, colour, materials, care instructions, package count and weight, rating and images.\n\nCalls `bowmark.providers.ikea.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetProductArgs","description":"TypeScript: `GetProductArgs`"}},"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/ikea/getProductRatings":{"post":{"operationId":"getProductRatings","summary":"Reads a product's customer rating summary — average stars, rating count, the per-star distribution, per-aspect scores (assembly, quality, value) and recommend counts; null when nobody has rated it.","description":"Reads a product's customer rating summary — average stars, rating count, the per-star distribution, per-aspect scores (assembly, quality, value) and recommend counts; null when nobody has rated it.\n\nCalls `bowmark.providers.ikea.getProductRatings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaProductRatings | null>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetProductRatingsArgs","description":"TypeScript: `GetProductRatingsArgs`"}},"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/ikea/getProductDocuments":{"post":{"operationId":"getProductDocuments","summary":"Lists a product's documents — assembly instructions, care manuals, declarations and other PDFs — with direct download links, one per part for a combination.","description":"Lists a product's documents — assembly instructions, care manuals, declarations and other PDFs — with direct download links, one per part for a combination.\n\nCalls `bowmark.providers.ikea.getProductDocuments`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaProductDocument[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetProductDocumentsArgs","description":"TypeScript: `GetProductDocumentsArgs`"}},"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/ikea/findStores":{"post":{"operationId":"findStores","summary":"Lists IKEA's US stores, optionally nearest a ZIP code or in one state, with address, coordinates, opening hours, holiday closures and the storeId the stock check takes.","description":"Lists IKEA's US stores, optionally nearest a ZIP code or in one state, with address, coordinates, opening hours, holiday closures and the storeId the stock check takes.\n\nCalls `bowmark.providers.ikea.findStores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaStore[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FindStoresArgs","description":"TypeScript: `FindStoresArgs`"}},"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/ikea/getProductAvailability":{"post":{"operationId":"getProductAvailability","summary":"Checks whether items are in stock at each US IKEA store and for home delivery: shelf quantity, stock band, click-and-collect and the aisle/bin to pick it from.","description":"Checks whether items are in stock at each US IKEA store and for home delivery: shelf quantity, stock band, click-and-collect and the aisle/bin to pick it from.\n\nCalls `bowmark.providers.ikea.getProductAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaAvailability[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetProductAvailabilityArgs","description":"TypeScript: `GetProductAvailabilityArgs`"}},"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/ikea/getDeliveryOptions":{"post":{"operationId":"getDeliveryOptions","summary":"Checks home-delivery eligibility for a ZIP, or click-and-collect and in-store stock for a store, plus the delivery price and lead time IKEA has computed so far — often null until checkout, which this ","description":"Checks home-delivery eligibility for a ZIP, or click-and-collect and in-store stock for a store, plus the delivery price and lead time IKEA has computed so far — often null until checkout, which this reports honestly rather than guessing.\n\nCalls `bowmark.providers.ikea.getDeliveryOptions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaDeliveryOptions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetDeliveryOptionsArgs","description":"TypeScript: `GetDeliveryOptionsArgs`"}},"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/ikea/lookupOrder":{"post":{"operationId":"lookupOrder","summary":"Looks up one order as a guest — no account needed, the same 'Track and manage' lookup the site offers signed-out visitors — by order number plus the email or phone number used when placing it.","description":"Looks up one order as a guest — no account needed, the same 'Track and manage' lookup the site offers signed-out visitors — by order number plus the email or phone number used when placing it. Returns the order's status and each delivery method's status, tense and dates.\n\nCalls `bowmark.providers.ikea.lookupOrder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaOrderLookup>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/LookupOrderArgs","description":"TypeScript: `LookupOrderArgs`"}},"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/ikea/getProfile":{"post":{"operationId":"getProfile","summary":"Reads the signed-in caller's IKEA profile — name, email, mobile, verification flags, IKEA Family member number, preferred store and ZIP.","description":"Reads the signed-in caller's IKEA profile — name, email, mobile, verification flags, IKEA Family member number, preferred store and ZIP. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.getProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaProfile>`.","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/ikea/getFamilyMembership":{"post":{"operationId":"getFamilyMembership","summary":"Reads the signed-in caller's IKEA Family membership — whether they are a member, the Family card number and IKEA's customer id.","description":"Reads the signed-in caller's IKEA Family membership — whether they are a member, the Family card number and IKEA's customer id. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.getFamilyMembership`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaFamilyMembership>`.","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/ikea/listFamilyOffers":{"post":{"operationId":"listFamilyOffers","summary":"Lists the signed-in caller's IKEA Family offers — their personal coupons, partner coupons and the member benefits IKEA shows in the loyalty hub.","description":"Lists the signed-in caller's IKEA Family offers — their personal coupons, partner coupons and the member benefits IKEA shows in the loyalty hub. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.listFamilyOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaFamilyOffers>`.","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/ikea/bookPlanningAppointment":{"post":{"operationId":"bookPlanningAppointment","summary":"Books a free IKEA planning appointment (kitchen, bedroom, office…) at a store or online, step by step: pass a ZIP to list services, add a serviceId to list stores or open slots, then a timeSlotId with","description":"Books a free IKEA planning appointment (kitchen, bedroom, office…) at a store or online, step by step: pass a ZIP to list services, add a serviceId to list stores or open slots, then a timeSlotId with the caller's contact details to book. Refuses any paid service. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.bookPlanningAppointment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaPlanningAppointment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/BookPlanningAppointmentArgs","description":"TypeScript: `BookPlanningAppointmentArgs`"},"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/ikea/updateProfile":{"post":{"operationId":"updateProfile","summary":"Edits the signed-in caller's own IKEA personal details — first name, last name, birth date or gender.","description":"Edits the signed-in caller's own IKEA personal details — first name, last name, birth date or gender. Only the fields passed are changed. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.updateProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaProfileUpdateResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/UpdateProfileArgs","description":"TypeScript: `UpdateProfileArgs`"},"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/ikea/listPurchases":{"post":{"operationId":"listPurchases","summary":"Lists the signed-in caller's IKEA purchases — online orders, store receipts and returns — with number, type, status, date, store, total and the first few items.","description":"Lists the signed-in caller's IKEA purchases — online orders, store receipts and returns — with number, type, status, date, store, total and the first few items. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.listPurchases`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaPurchaseHistory>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListPurchasesArgs","description":"TypeScript: `ListPurchasesArgs`"},"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/ikea/getPurchase":{"post":{"operationId":"getPurchase","summary":"Reads one of the signed-in caller's orders by order number — its status and each delivery method's status and dates.","description":"Reads one of the signed-in caller's orders by order number — its status and each delivery method's status and dates. Needs the caller signed in to IKEA.\n\nCalls `bowmark.providers.ikea.getPurchase`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaOrderLookup>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetPurchaseArgs","description":"TypeScript: `GetPurchaseArgs`"},"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/ikea/listCategories":{"post":{"operationId":"listCategories","summary":"Lists IKEA's US product category tree (e.g.","description":"Lists IKEA's US product category tree (e.g. Storage & organization → Bookcases & shelving units) with each category's id, URL and image; pass parentId to walk down a branch.\n\nCalls `bowmark.providers.ikea.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListCategoriesArgs","description":"TypeScript: `ListCategoriesArgs`"}},"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/ikea/listCategoryProducts":{"post":{"operationId":"listCategoryProducts","summary":"Lists the products in one IKEA category, paged, with IKEA's own filters (colour, size, material, price band, series…) and sort orders; returns the available filter values with counts.","description":"Lists the products in one IKEA category, paged, with IKEA's own filters (colour, size, material, price band, series…) and sort orders; returns the available filter values with counts.\n\nCalls `bowmark.providers.ikea.listCategoryProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCategoryProducts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListCategoryProductsArgs","description":"TypeScript: `ListCategoryProductsArgs`"}},"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/ikea/listOffers":{"post":{"operationId":"listOffers","summary":"Lists IKEA US products on offer — IKEA Family prices by default, or last-chance discontinued items — with the offer price, the regular price it is cut from, the discount and the dates it runs; pageabl","description":"Lists IKEA US products on offer — IKEA Family prices by default, or last-chance discontinued items — with the offer price, the regular price it is cut from, the discount and the dates it runs; pageable and narrowable to a category.\n\nCalls `bowmark.providers.ikea.listOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCategoryProducts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListOffersArgs","description":"TypeScript: `ListOffersArgs`"}},"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/ikea/listNewProducts":{"post":{"operationId":"listNewProducts","summary":"Lists IKEA US products marked as new arrivals, with the same filters, sort orders and offer data as listCategoryProducts; pageable and narrowable to a category.","description":"Lists IKEA US products marked as new arrivals, with the same filters, sort orders and offer data as listCategoryProducts; pageable and narrowable to a category.\n\nCalls `bowmark.providers.ikea.listNewProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCategoryProducts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListNewProductsArgs","description":"TypeScript: `ListNewProductsArgs`"}},"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/ikea/listInspiration":{"post":{"operationId":"listInspiration","summary":"Lists one room's idea content — photographed room galleries, how-to articles, product guides and editorials — with title, image and url.","description":"Lists one room's idea content — photographed room galleries, how-to articles, product guides and editorials — with title, image and url.\n\nCalls `bowmark.providers.ikea.listInspiration`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaInspiration[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListInspirationArgs","description":"TypeScript: `ListInspirationArgs`"}},"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/ikea/addToCart":{"post":{"operationId":"addToCart","summary":"Adds an item to an IKEA cart by item number and quantity, starting a new guest cart when cartToken is omitted.","description":"Adds an item to an IKEA cart by item number and quantity, starting a new guest cart when cartToken is omitted. Never checks out. Also returns `checkout`: the first item's product page with every item to add again (a guest cart no link can open), or a refusal when the cart is empty.\n\nCalls `bowmark.providers.ikea.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCart & { checkout: IkeaCheckoutHandoff }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/AddToCartArgs","description":"TypeScript: `AddToCartArgs`"}},"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/ikea/getCart":{"post":{"operationId":"getCart","summary":"Reads a cart's items, quantities and total — a fresh empty one if cartToken is omitted.","description":"Reads a cart's items, quantities and total — a fresh empty one if cartToken is omitted. Also returns `checkout`, the same product-page handoff (a refusal when the cart is empty).\n\nCalls `bowmark.providers.ikea.getCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCart & { checkout: IkeaCheckoutHandoff }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetCartArgs","description":"TypeScript: `GetCartArgs`"}},"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/ikea/updateCartItem":{"post":{"operationId":"updateCartItem","summary":"Sets the quantity of an item already in a cart.","description":"Sets the quantity of an item already in a cart. Also returns `checkout`, the product-page handoff with the new quantity.\n\nCalls `bowmark.providers.ikea.updateCartItem`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCart & { checkout: IkeaCheckoutHandoff }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/UpdateCartItemArgs","description":"TypeScript: `UpdateCartItemArgs`"}},"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/ikea/removeFromCart":{"post":{"operationId":"removeFromCart","summary":"Removes an item from a cart.","description":"Removes an item from a cart. Also returns `checkout`: the product-page handoff for what is left, or a refusal when the cart is now empty.\n\nCalls `bowmark.providers.ikea.removeFromCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaCart & { checkout: IkeaCheckoutHandoff }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/RemoveFromCartArgs","description":"TypeScript: `RemoveFromCartArgs`"}},"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/ikea/addToFavorites":{"post":{"operationId":"addToFavorites","summary":"Saves a product to an IKEA favorites list (IKEA's shopping list) by item number and quantity, starting a fresh identity's list when favoritesToken is omitted.","description":"Saves a product to an IKEA favorites list (IKEA's shopping list) by item number and quantity, starting a fresh identity's list when favoritesToken is omitted.\n\nCalls `bowmark.providers.ikea.addToFavorites`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaFavoritesList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/AddToFavoritesArgs","description":"TypeScript: `AddToFavoritesArgs`"}},"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/ikea/listFavorites":{"post":{"operationId":"listFavorites","summary":"Reads every favorites list on an identity — a fresh, empty one if favoritesToken is omitted.","description":"Reads every favorites list on an identity — a fresh, empty one if favoritesToken is omitted.\n\nCalls `bowmark.providers.ikea.listFavorites`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaFavoritesList[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListFavoritesArgs","description":"TypeScript: `ListFavoritesArgs`"}},"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/ikea/removeFromFavorites":{"post":{"operationId":"removeFromFavorites","summary":"Removes a product from a favorites list.","description":"Removes a product from a favorites list.\n\nCalls `bowmark.providers.ikea.removeFromFavorites`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IkeaFavoritesList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/RemoveFromFavoritesArgs","description":"TypeScript: `RemoveFromFavoritesArgs`"}},"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":{"itemNo":{"type":"string"},"quantity":{"type":"number"},"cartToken":{"type":"string"}},"required":["itemNo","quantity"],"additionalProperties":true},"AddToFavoritesArgs":{"type":"object","properties":{"itemNo":{"type":"string"},"quantity":{"type":"number"},"listId":{"type":"string"},"favoritesToken":{"type":"string"}},"required":["itemNo"],"additionalProperties":true},"BookPlanningAppointmentArgs":{"type":"object","properties":{"zip":{"type":"string"},"operation":{"type":"string"},"state":{"type":"string"},"serviceId":{"type":"string"},"storeId":{"type":"string"},"from":{"type":"string"},"timeSlotId":{"type":"string"},"customer":{"type":"object","properties":{"firstName":{"type":"string"},"surName":{"type":"string"},"email":{"type":"string"},"mobileNumber":{"type":"string"},"address1":{"type":"string"},"city":{"type":"string"},"postCode":{"type":"string"}},"required":["firstName","surName","email","mobileNumber"],"additionalProperties":true}},"required":["zip"],"additionalProperties":true},"FindStoresArgs":{"type":"object","properties":{"zip":{"type":"string"},"state":{"type":"string"},"limit":{"type":"number"}},"additionalProperties":true},"GetCartArgs":{"type":"object","properties":{"cartToken":{"type":"string"}},"additionalProperties":true},"GetDeliveryOptionsArgs":{"type":"object","properties":{"itemNos":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"quantity":{"type":"number"},"zip":{"type":"string"},"storeId":{"type":"string"}},"required":["itemNos"],"additionalProperties":true},"GetProductArgs":{"type":"object","properties":{"itemNo":{"type":"string"}},"required":["itemNo"],"additionalProperties":true},"GetProductAvailabilityArgs":{"type":"object","properties":{"itemNos":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"storeId":{"type":"string"}},"required":["itemNos"],"additionalProperties":true},"GetProductDocumentsArgs":{"type":"object","properties":{"itemNo":{"type":"string"}},"required":["itemNo"],"additionalProperties":true},"GetProductRatingsArgs":{"type":"object","properties":{"itemNo":{"type":"string"}},"required":["itemNo"],"additionalProperties":true},"GetPurchaseArgs":{"type":"object","properties":{"orderNumber":{"type":"string"}},"required":["orderNumber"],"additionalProperties":true},"ListCategoriesArgs":{"type":"object","properties":{"parentId":{"type":"string"},"depth":{"type":"number"}},"additionalProperties":true},"ListCategoryProductsArgs":{"type":"object","properties":{"categoryId":{"type":"string"},"filters":{"type":"object","additionalProperties":{"anyOf":[{"type":"array","items":{"type":"string"}},{"const":true}]}},"sort":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"required":["categoryId"],"additionalProperties":true},"ListFavoritesArgs":{"type":"object","properties":{"favoritesToken":{"type":"string"}},"additionalProperties":true},"ListInspirationArgs":{"type":"object","properties":{"room":{"type":"string"}},"required":["room"],"additionalProperties":true},"ListNewProductsArgs":{"type":"object","properties":{"categoryId":{"type":"string"},"sort":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"additionalProperties":true},"ListOffersArgs":{"type":"object","properties":{"type":{"type":"string"},"categoryId":{"type":"string"},"sort":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"additionalProperties":true},"ListPurchasesArgs":{"type":"object","properties":{"limit":{"type":"number"},"offset":{"type":"number"}},"additionalProperties":true},"LookupOrderArgs":{"type":"object","properties":{"orderNumber":{"type":"string"},"liteId":{"type":"string"}},"required":["orderNumber","liteId"],"additionalProperties":true},"RemoveFromCartArgs":{"type":"object","properties":{"itemNo":{"type":"string"},"cartToken":{"type":"string"}},"required":["itemNo","cartToken"],"additionalProperties":true},"RemoveFromFavoritesArgs":{"type":"object","properties":{"itemNo":{"type":"string"},"favoritesToken":{"type":"string"},"listId":{"type":"string"}},"required":["itemNo","favoritesToken"],"additionalProperties":true},"SearchProductsArgs":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true},"SuggestSearchTermsArgs":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"],"additionalProperties":true},"UpdateCartItemArgs":{"type":"object","properties":{"itemNo":{"type":"string"},"quantity":{"type":"number"},"cartToken":{"type":"string"}},"required":["itemNo","quantity","cartToken"],"additionalProperties":true},"UpdateProfileArgs":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"birthDate":{"type":"string"},"genderCode":{"type":"string"}},"additionalProperties":true}}}}