IKEA MCP server for AI agents
Let Claude, ChatGPT or your own agent read and act on IKEA: 28 typed functions through one MCP server. No IKEA API key needed.
- Site
- ikea.com
- Functions
- 28
- Sign-in
- For account actions
- Works with
- MCP, HTTP, Node, Python
Connect
An MCP server for IKEA alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.
https://api.bowmark.ai/mcp/site/ikeaOne MCP server for IKEA and every other site Bowmark covers. Your agent looks up what it needs and calls it.
https://api.bowmark.ai/mcpSet it up in your clientBoth need a Bowmark API key. The quickstart gets you one and a first result in a few minutes. Functions that need a login use the person's own account: how sign-in works.
Functions
Open a function to see its arguments, what it returns and how to call it.
findStoresLists IKEA's US stores, optionally near a ZIP code or in a state, with address, coordinates, opening hours and store id.Arguments
Name Type Required zipstringA 5-digit US ZIP; stores come back nearest first with distanceMiles.No statestringTwo-letter state, e.g. "CA".No limitnumberNo Returns
IkeaStore[]interface IkeaStoreHours { day: string; open: string; close: string; } interface IkeaStore { storeId: string; name: string; displayName: string | null; street: string | null; city: string | null; state: string | null; zip: string | null; latitude: number | null; longitude: number | null; timezone: string | null; kind: string | null; hours: IkeaStoreHours[]; clickAndCollectHours: IkeaStoreHours[]; exceptions: { date: string; open: string | null; close: string | null; reason: string | null }[]; url: string | null; distanceMiles: number | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/findStoresCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.findStores({ zip: "94103" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.findStores({"zip": "94103"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/findStores \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"zip":"94103"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.findStores({ zip: "94103" });getCartReads a cart's items, quantities, line prices and total.Arguments
Name Type Required cartTokenstringThe cartToken a prior addToCart/getCart call returned.No Returns
IkeaCart & { checkout: IkeaCheckoutHandoff }interface IkeaCartItem { itemNo: string; quantity: number; price: number | null; } interface IkeaCart { /** Pass this back as `cartToken` to getCart, updateCartItem and removeFromCart * to keep working with THIS cart, omitting it always starts a new, empty one. */ cartToken: string; cartId: string; empty: boolean; items: IkeaCartItem[]; quantity: number; updatedAt: string | null; // Where the PERSON finishes: the first item's product page with every item listed to add again (the cart is a guest cart no link can open); a refusal when the cart is empty. Bowmark never checks out. checkout: IkeaCheckoutHandoff; } // The checkout handoff: where the PERSON finishes. Bowmark never pays, books or orders. // Switch on `status`; a status you do not recognise means "show the person `url` and stop". interface IkeaCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; // the https page to open on the site urlKind?: "carries_items" | "signed_in_cart" | "product_page"; // ready_to_checkout only: does the link carry the items, or only open the item's page reason?: string; // unavailable only: out_of_stock | not_available_for_dates | not_sold_online | region_not_served | quantity_unavailable | empty_cart detail?: string; // unavailable only: one sentence saying why account: { site: string; hint: string; signedInAs?: string }; summary: { items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[]; total: string | null; currency: string } | null; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getCartCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getCart({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getCart({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getCart \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getCart({});getDeliveryOptionsChecks home-delivery eligibility and quantity for a ZIP, or click-and-collect and in-store stock for a store, plus the delivery price and lead time…Arguments
Name Type Required itemNosstring | string[]One item number, or several.Yes quantitynumberApplied to every item; default 1.No zipstringA 5-digit US ZIP, checks home-delivery eligibility there.No storeIdstringA storeId from findStores, checks click-and-collect and in-store stock there instead.No Returns
IkeaDeliveryOptionsinterface IkeaDeliveryQuantity { available: boolean | null; /** The site's own reason the item cannot go this way, e.g. "OUT_OF_STOCK". */ reasonCode: string | null; quantity: number | null; } interface IkeaCashAndCarry { available: boolean | null; quantity: number | null; stockLevel: string | null; department: string | null; } interface IkeaItemDeliveryOptions { itemNo: string; homeDelivery: IkeaDeliveryQuantity; clickAndCollect: IkeaDeliveryQuantity; cashAndCarry: IkeaCashAndCarry; } interface IkeaDeliveryPrice { /** In dollars. Null when IKEA has not computed one yet, usually true until checkout. */ current: number | null; original: number | null; discounted: boolean; } interface IkeaDeliveryOptions { isEligibleForParcelDelivery: boolean; isEligibleForTruckDelivery: boolean; items: IkeaItemDeliveryOptions[]; homeDelivery: { price: IkeaDeliveryPrice; leadTimeDays: string | null }; clickAndCollect: { price: IkeaDeliveryPrice; leadTimeDays: string | null }; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getDeliveryOptionsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getDeliveryOptions({ itemNos: "20522046", zip: "10001" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getDeliveryOptions({"itemNos": "20522046", "zip": "10001"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getDeliveryOptions \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNos":"20522046","zip":"10001"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getDeliveryOptions({ itemNos: "20522046", zip: "10001" });getFamilyMembershipReads the signed-in caller's IKEA Family membership.Arguments
None.
Returns
IkeaFamilyMembershipinterface IkeaFamilyMembership { /** True when the account's first loyalty card is an IKEA Family card. */ isMember: boolean; /** The IKEA Family card number, when a member. */ cardNumber: string | null; /** The card type IKEA reports (e.g. "FAMILY"), or null with no card. */ cardType: string | null; /** IKEA's customer id for the account. */ customerId: string | null; /** Every loyalty card on the account. */ cards: { cardNumber: string | null; cardType: string | null }[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getFamilyMembershipCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getFamilyMembership({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getFamilyMembership({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getFamilyMembership \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"opts":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getFamilyMembership({});getProductReads one product page by item number or URL: name, price, description, dimensions, colour, materials, care instructions, package count and weight…Arguments
Name Type Required itemNostringYes Returns
IkeaProductinterface IkeaProductMaterial { part: string; material: string; } interface IkeaProduct { itemNo: string; name: string; price: number | null; currency: string | null; description: string | null; color: string | null; dimensions: { height: string | null; width: string | null; depth: string | null }; rating: { average: number; count: number } | null; images: string[]; materials: IkeaProductMaterial[]; careInstructions: string[]; packageCount: number | null; packageWeight: string | null; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getProductCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getProduct({ itemNo: "20522046" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getProduct({"itemNo": "20522046"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getProduct \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"20522046"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getProduct({ itemNo: "20522046" });getProductAvailabilityChecks whether an item is in stock at each US IKEA store and for home delivery: cash-and-carry quantity, click-and-collect, restock dates…Arguments
Name Type Required itemNosstring | string[]One item number, or several.Yes storeIdstringOnly this store's row (a storeId from findStores).No Returns
IkeaAvailability[]interface IkeaStoreStock { storeId: string; cashAndCarry: boolean; clickAndCollect: boolean; quantity: number | null; stockLevel: string | null; aisles: string[]; } interface IkeaAvailability { itemNo: string; homeDelivery: boolean; stores: IkeaStoreStock[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getProductAvailabilityCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getProductAvailability({ itemNos: "20522046" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getProductAvailability({"itemNos": "20522046"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getProductAvailability \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNos":"20522046"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getProductAvailability({ itemNos: "20522046" });getProductDocumentsLists a product's documents.Arguments
Name Type Required itemNostringAn itemNo from searchProducts, e.g. "20522046".Yes Returns
IkeaProductDocument[]interface IkeaProductDocument { /** IKEA's group key: "assembly", "manual", "declaration", "other"… */ type: string; /** The group heading, e.g. "Assembly instructions". */ heading: string; /** The part it covers, e.g. "BILLY Bookcase". */ label: string; /** A direct PDF link. */ url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getProductDocumentsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getProductDocuments({ itemNo: "20522046" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getProductDocuments({"itemNo": "20522046"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getProductDocuments \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"20522046"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getProductDocuments({ itemNo: "20522046" });getProductRatingsReads a product's customer rating summary.Arguments
Name Type Required itemNostringAn itemNo from searchProducts, e.g. "20522046".Yes Returns
IkeaProductRatings | nullinterface IkeaProductRatings { itemNo: string; average: number; ratingCount: number; reviewCount: number; /** Count per star, 1 to 5. */ distribution: { stars: number; count: number }[]; /** Per-aspect averages, e.g. "Ease of assembly/installation"; unrated aspects left out. */ aspects: { id: string; label: string; average: number }[]; recommendedCount: number | null; notRecommendedCount: number | null; firstReviewedOn: string | null; lastReviewedOn: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getProductRatingsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getProductRatings({ itemNo: "20522046" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getProductRatings({"itemNo": "20522046"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getProductRatings \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"20522046"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getProductRatings({ itemNo: "20522046" });getProfileReads the signed-in caller's IKEA profile.Arguments
None.
Returns
IkeaProfileinterface IkeaProfile { firstName: string | null; lastName: string | null; email: string | null; mobile: string | null; emailVerified: boolean | null; phoneVerified: boolean | null; /** The IKEA Family / loyalty member number, when the caller has one. */ memberId: string | null; /** e.g. "FAMILY", the loyalty programme the account is enrolled in. */ loyaltyProgramCode: string | null; /** The preferred store's id. */ preferredStore: string | null; zipCode: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getProfileCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getProfile({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getProfile({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getProfile \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"opts":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getProfile({});getPurchaseReads one of the signed-in caller's purchases by order number.Arguments
Name Type Required orderNumberstring9-10 digits, an online order's number, as listPurchases returns it.Yes Returns
IkeaOrderLookupinterface IkeaOrderDeliveryDate { time: string | null; date: string | null; formattedShortDate: string | null; formattedLongDate: string | null; } interface IkeaOrderDeliveryMethod { type: string | null; deliveryStatus: string | null; tense: string | null; actual: IkeaOrderDeliveryDate | null; estimatedFrom: IkeaOrderDeliveryDate | null; estimatedTo: IkeaOrderDeliveryDate | null; } interface IkeaOrderLookup { orderNumber: string; status: string | null; // the site's own labels, read the values off a result, never guess one from prose deliveryMethods: IkeaOrderDeliveryMethod[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/getPurchaseCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.getPurchase({ orderNumber: "100000001" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.getPurchase({"orderNumber": "100000001"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/getPurchase \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"orderNumber":"100000001"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.getPurchase({ orderNumber: "100000001" });listCategoriesLists IKEA's product category tree (e.g. Furniture → Bookcases & shelving units) with each category's id and URL.Arguments
Name Type Required parentIdstringOnly this category's subcategories (an id from a previous call); omit for the top level.No depthnumberLevels of subcategories to include under each row (0-5, default 1).No Returns
IkeaCategory[]interface IkeaCategory { id: string; name: string; url: string; imageUrl: string | null; childCount: number; subcategories?: IkeaCategory[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listCategoriesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listCategories({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listCategories({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listCategories \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listCategories({});listCategoryProductsLists the products in one category with IKEA's own filters (price, colour, material, size) and sort orders, paged.Arguments
Name Type Required categoryIdstringA category id from listCategories, e.g. "st002".Yes filtersRecord<string, string[] | true>Facets from a previous call's filters: { "f-colors": ["10156"], "f-top-seller": true }.No sortstringA sortOrders id, e.g. "PRICE_LOW_TO_HIGH".No limitnumber1-100, default 24.No offsetnumberNo Returns
IkeaCategoryProductsinterface IkeaSearchProduct { itemNo: string; name: string; typeName: string | null; price: number | null; currency: string | null; rating: { average: number; count: number } | null; colors: string[]; url: string; imageUrl: string | null; /** Set when the price is an offer. */ offer: { tag: string | null; label: string | null; previousPrice: number | null; discountPercent: number | null; validFrom: string | null; validTo: string | null; } | null; } interface IkeaFilter { parameter: string; name: string; kind: "values" | "boolean"; values: { id: string; name: string; count: number | null }[]; } interface IkeaCategoryProducts { categoryId: string; total: number | null; offset: number; products: IkeaSearchProduct[]; filters: IkeaFilter[]; sortOrders: { id: string; name: string }[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listCategoryProductsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listCategoryProducts({ categoryId: "st002" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listCategoryProducts({"categoryId": "st002"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listCategoryProducts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"categoryId":"st002"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listCategoryProducts({ categoryId: "st002" });listFamilyOffersLists the signed-in caller's IKEA Family offers.Arguments
None.
Returns
IkeaFamilyOffersinterface IkeaFamilyOffers { /** IKEA's own personal coupons, as IKEA sends them (signed-in shape unmeasured). */ offers: Record<string, unknown>[]; /** Coupons from IKEA's partners, as IKEA sends them. */ partnerOffers: Record<string, unknown>[]; /** The member benefits IKEA lists for the account, as sent; null when that call failed. */ benefits: unknown; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listFamilyOffersCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listFamilyOffers({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listFamilyOffers({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listFamilyOffers \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"opts":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listFamilyOffers({});listFavoritesReads every favorites list on an identity.Arguments
Name Type Required favoritesTokenstringThe favoritesToken a prior favorites call returned.No Returns
IkeaFavoritesList[]interface IkeaFavoritesItem { itemNo: string; quantity: number; name: string | null; } interface IkeaFavoritesList { /** Pass this back as `favoritesToken` to listFavorites/removeFromFavorites to * keep reading THIS identity's lists, omitting it always starts a fresh, * empty identity, exactly like getCart's cartToken. */ favoritesToken: string; /** Pass this back as `listId` to removeFromFavorites to target THIS list, * omitting it always targets the identity's one selected list. */ listId: string; name: string | null; isSelected: boolean; quantity: number; updatedAt: string | null; items: IkeaFavoritesItem[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listFavoritesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listFavorites({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listFavorites({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listFavorites \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listFavorites({});listInspirationLists one room's idea content.Arguments
Name Type Required roomstringA room slug: "outdoor" | "kitchen" | "bathroom" | "living-room" | "bedroom" | "dining" | "home-office" | "childrens-room" | "gaming-room" | "hallway" | "garage" | "laundry".Yes Returns
IkeaInspiration[]interface IkeaInspiration { title: string; url: string; imageUrl: string | null; /** "gallery" (a photographed room with shoppable hotspots), "how-to", "guide" (a /product-guides/ piece) or "article" (an /ideas/ editorial). */ kind: "gallery" | "how-to" | "guide" | "article"; room: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listInspirationCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listInspiration({ room: "living-room" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listInspiration({"room": "living-room"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listInspiration \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"room":"living-room"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listInspiration({ room: "living-room" });listNewProductsLists IKEA US products marked as new arrivals, with the same filters, sort orders and offer data as listCategoryProducts; pageable and narrowable to…Arguments
Name Type Required categoryIdstringNarrow to one category id from listCategories; default the whole catalogue.No sortstringA sortOrders id, e.g. "PRICE_LOW_TO_HIGH".No limitnumber1-100, default 24.No offsetnumberNo Returns
IkeaCategoryProductsinterface IkeaSearchProduct { itemNo: string; name: string; typeName: string | null; price: number | null; currency: string | null; rating: { average: number; count: number } | null; colors: string[]; url: string; imageUrl: string | null; /** Set when the price is an offer. */ offer: { tag: string | null; label: string | null; previousPrice: number | null; discountPercent: number | null; validFrom: string | null; validTo: string | null; } | null; } interface IkeaFilter { parameter: string; name: string; kind: "values" | "boolean"; values: { id: string; name: string; count: number | null }[]; } interface IkeaCategoryProducts { categoryId: string; total: number | null; offset: number; products: IkeaSearchProduct[]; filters: IkeaFilter[]; sortOrders: { id: string; name: string }[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listNewProductsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listNewProducts({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listNewProducts({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listNewProducts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listNewProducts({});listOffersLists IKEA US products on offer.Arguments
Name Type Required typestringAn f-offers value: "FAMILY_PRICE" (default) or "DISCONTINUED" (last chance).No categoryIdstringNarrow to one category id from listCategories; default the whole catalogue.No sortstringA sortOrders id, e.g. "PRICE_LOW_TO_HIGH".No limitnumber1-100, default 24.No offsetnumberNo Returns
IkeaCategoryProductsinterface IkeaSearchProduct { itemNo: string; name: string; typeName: string | null; price: number | null; currency: string | null; rating: { average: number; count: number } | null; colors: string[]; url: string; imageUrl: string | null; /** Set when the price is an offer. */ offer: { tag: string | null; label: string | null; previousPrice: number | null; discountPercent: number | null; validFrom: string | null; validTo: string | null; } | null; } interface IkeaFilter { parameter: string; name: string; kind: "values" | "boolean"; values: { id: string; name: string; count: number | null }[]; } interface IkeaCategoryProducts { categoryId: string; total: number | null; offset: number; products: IkeaSearchProduct[]; filters: IkeaFilter[]; sortOrders: { id: string; name: string }[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listOffersCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listOffers({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listOffers({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listOffers \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listOffers({});listPurchasesLists the signed-in caller's IKEA purchases, online and in store, newest first, with order number, date, total and status.Arguments
Name Type Required limitnumber1-100, default 20.No offsetnumberSkip this many purchases, default 0.No Returns
IkeaPurchaseHistoryinterface IkeaPurchaseArticle { itemNo: string | null; name: string | null; description: string | null; quantity: number | null; imageUrl: string | null; } interface IkeaPurchase { /** The order or receipt number, pass an order's to getPurchase. */ id: string; /** e.g. "ORDER", "RECEIPT", "RETURN". */ type: string | null; status: string | null; // the site's own labels, read the values off a result, never guess one from prose date: string | null; storeName: string | null; total: { currency: string | null; value: number | null; formatted: string | null } | null; articleCount: number | null; articles: IkeaPurchaseArticle[]; } interface IkeaPurchaseHistory { totalPurchases: number | null; purchases: IkeaPurchase[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/listPurchasesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.listPurchases({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.listPurchases({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/listPurchases \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.listPurchases({});lookupOrderLooks up one order as a guest.Arguments
Name Type Required orderNumberstring9-10 digits, no spaces, as printed on the order confirmation.Yes liteIdstringThe email or phone number used when placing the order.Yes Returns
IkeaOrderLookupinterface IkeaOrderDeliveryDate { time: string | null; date: string | null; formattedShortDate: string | null; formattedLongDate: string | null; } interface IkeaOrderDeliveryMethod { type: string | null; deliveryStatus: string | null; tense: string | null; actual: IkeaOrderDeliveryDate | null; estimatedFrom: IkeaOrderDeliveryDate | null; estimatedTo: IkeaOrderDeliveryDate | null; } interface IkeaOrderLookup { orderNumber: string; status: string | null; // the site's own labels, read the values off a result, never guess one from prose deliveryMethods: IkeaOrderDeliveryMethod[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/lookupOrderCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.lookupOrder({ orderNumber: "<orderNumber>", liteId: "<liteId>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.lookupOrder({"orderNumber": "<orderNumber>", "liteId": "<liteId>"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/lookupOrder \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"orderNumber":"<orderNumber>","liteId":"<liteId>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.lookupOrder({ orderNumber: "<orderNumber>", liteId: "<liteId>" });searchProductsSearches IKEA's US catalogue by keyword and returns each product's item number, name, type, price, rating, colour variants and product-page URL.Arguments
Name Type Required querystringYes limitnumberNo Returns
IkeaSearchProduct[]interface IkeaSearchProduct { itemNo: string; name: string; typeName: string | null; price: number | null; currency: string | null; rating: { average: number; count: number } | null; colors: string[]; url: string; imageUrl: string | null; /** Set when the price is an offer. */ offer: { tag: string | null; label: string | null; previousPrice: number | null; discountPercent: number | null; validFrom: string | null; validTo: string | null; } | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/searchProductsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.searchProducts({ query: "billy bookcase" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.searchProducts({"query": "billy bookcase"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/searchProducts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"query":"billy bookcase"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.searchProducts({ query: "billy bookcase" });suggestSearchTermsReturns 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…Arguments
Name Type Required querystringWhat the caller has typed so far, e.g. "sof".Yes Returns
IkeaSearchSuggestionsinterface IkeaSearchSuggestions { /** Completed search terms, most-searched first. */ terms: string[]; /** Categories offered for the prefix, id is what listCategoryProducts takes. */ categories: { id: string; name: string; url: string; imageUrl: string | null }[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/suggestSearchTermsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.suggestSearchTerms({ query: "sof" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.suggestSearchTerms({"query": "sof"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/suggestSearchTerms \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"query":"sof"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.suggestSearchTerms({ query: "sof" });
addToCartAdds an item (by item number and quantity) to an IKEA shopping cart and returns the cart, creating a guest cart when the caller has none.Arguments
Name Type Required itemNostringAn itemNo from searchProducts, e.g. "20522046".Yes quantitynumberYes cartTokenstringOmit to start a new guest cart; pass one a prior cart call returned to add to it.No Returns
IkeaCart & { checkout: IkeaCheckoutHandoff }interface IkeaCartItem { itemNo: string; quantity: number; price: number | null; } interface IkeaCart { /** Pass this back as `cartToken` to getCart, updateCartItem and removeFromCart * to keep working with THIS cart, omitting it always starts a new, empty one. */ cartToken: string; cartId: string; empty: boolean; items: IkeaCartItem[]; quantity: number; updatedAt: string | null; // Where the PERSON finishes: the first item's product page with every item listed to add again (the cart is a guest cart no link can open); a refusal when the cart is empty. Bowmark never checks out. checkout: IkeaCheckoutHandoff; } // The checkout handoff: where the PERSON finishes. Bowmark never pays, books or orders. // Switch on `status`; a status you do not recognise means "show the person `url` and stop". interface IkeaCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; // the https page to open on the site urlKind?: "carries_items" | "signed_in_cart" | "product_page"; // ready_to_checkout only: does the link carry the items, or only open the item's page reason?: string; // unavailable only: out_of_stock | not_available_for_dates | not_sold_online | region_not_served | quantity_unavailable | empty_cart detail?: string; // unavailable only: one sentence saying why account: { site: string; hint: string; signedInAs?: string }; summary: { items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[]; total: string | null; currency: string } | null; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/addToCartCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.addToCart({ itemNo: "<itemNo>", quantity: 1 });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.addToCart({"itemNo": "<itemNo>", "quantity": 1}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/addToCart \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"<itemNo>","quantity":1}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.addToCart({ itemNo: "<itemNo>", quantity: 1 });addToFavoritesSaves 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…Arguments
Name Type Required itemNostringAn itemNo from searchProducts, e.g. "20522046".Yes quantitynumberNo listIdstringA listId a prior favorites call returned.No favoritesTokenstringOmit to start a fresh identity's list; pass one a prior favorites call returned to add to it.No Returns
IkeaFavoritesListinterface IkeaFavoritesItem { itemNo: string; quantity: number; name: string | null; } interface IkeaFavoritesList { /** Pass this back as `favoritesToken` to listFavorites/removeFromFavorites to * keep reading THIS identity's lists, omitting it always starts a fresh, * empty identity, exactly like getCart's cartToken. */ favoritesToken: string; /** Pass this back as `listId` to removeFromFavorites to target THIS list, * omitting it always targets the identity's one selected list. */ listId: string; name: string | null; isSelected: boolean; quantity: number; updatedAt: string | null; items: IkeaFavoritesItem[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/addToFavoritesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.addToFavorites({ itemNo: "<itemNo>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.addToFavorites({"itemNo": "<itemNo>"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/addToFavorites \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"<itemNo>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.addToFavorites({ itemNo: "<itemNo>" });bookPlanningAppointmentBooks a free IKEA planning appointment (kitchen, bedroom, office…) at a store or online for the signed-in caller, step by step: services, then stores…Arguments
Name Type Required zipstringThe 5-digit US ZIP the appointment is for.Yes operationstringIKEA's service group, e.g. "KITCHENPLANNING" (default), "KITCHEN", "BEDROOM", "WORKSPACE".No statestringTwo-letter state code; some groups list more services with it.No serviceIdstringA serviceId off the "services" step.No storeIdstringA storeId off the "stores" step.No fromstringFirst day to list slots from, YYYY-MM-DD; default today.No timeSlotIdstringA timeSlotId off the "slots" step.No customer{ firstName: string; surName: string; email: string; mobileNumber: string; address1?: string; city?: string; postCode?: string; }No Returns
IkeaPlanningAppointmentinterface IkeaPlanningAppointment { /** Which step this answer is: what to pass next, or the booking. */ step: "services" | "stores" | "slots" | "booked"; services?: { serviceId: string; serviceCode: string; operation: string; /** STORE, REMOTE or HOME. */ locationType: string; /** Highest listed price in USD; 0 is free. Only free services book. */ price: number; external: boolean; }[]; stores?: { storeId: string; name: string; street: string | null; city: string | null; zip: string | null }[]; slots?: { timeSlotId: string; from: string; to: string | null }[]; booking?: { orderNo: string | null; payOrderLink: string | null; raw: Record<string, unknown> }; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/bookPlanningAppointmentCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.bookPlanningAppointment({ zip: "<zip>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.bookPlanningAppointment({"zip": "<zip>"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/bookPlanningAppointment \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"zip":"<zip>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.bookPlanningAppointment({ zip: "<zip>" });removeFromCartRemoves an item from a cart.Arguments
Name Type Required itemNostringAn itemNo already in the cart.Yes cartTokenstringThe cartToken the cart was created or last read with.Yes Returns
IkeaCart & { checkout: IkeaCheckoutHandoff }interface IkeaCartItem { itemNo: string; quantity: number; price: number | null; } interface IkeaCart { /** Pass this back as `cartToken` to getCart, updateCartItem and removeFromCart * to keep working with THIS cart, omitting it always starts a new, empty one. */ cartToken: string; cartId: string; empty: boolean; items: IkeaCartItem[]; quantity: number; updatedAt: string | null; // Where the PERSON finishes: the first item's product page with every item listed to add again (the cart is a guest cart no link can open); a refusal when the cart is empty. Bowmark never checks out. checkout: IkeaCheckoutHandoff; } // The checkout handoff: where the PERSON finishes. Bowmark never pays, books or orders. // Switch on `status`; a status you do not recognise means "show the person `url` and stop". interface IkeaCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; // the https page to open on the site urlKind?: "carries_items" | "signed_in_cart" | "product_page"; // ready_to_checkout only: does the link carry the items, or only open the item's page reason?: string; // unavailable only: out_of_stock | not_available_for_dates | not_sold_online | region_not_served | quantity_unavailable | empty_cart detail?: string; // unavailable only: one sentence saying why account: { site: string; hint: string; signedInAs?: string }; summary: { items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[]; total: string | null; currency: string } | null; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/removeFromCartCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.removeFromCart({ itemNo: "<itemNo>", cartToken: "<cartToken>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.removeFromCart({"itemNo": "<itemNo>", "cartToken": "<cartToken>"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/removeFromCart \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"<itemNo>","cartToken":"<cartToken>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.removeFromCart({ itemNo: "<itemNo>", cartToken: "<cartToken>" });removeFromFavoritesRemoves a product from a favorites list.Arguments
Name Type Required itemNostringAn itemNo already on the list.Yes favoritesTokenstringThe favoritesToken the list was created or last read with.Yes listIdstringA listId a prior favorites call returned.No Returns
IkeaFavoritesListinterface IkeaFavoritesItem { itemNo: string; quantity: number; name: string | null; } interface IkeaFavoritesList { /** Pass this back as `favoritesToken` to listFavorites/removeFromFavorites to * keep reading THIS identity's lists, omitting it always starts a fresh, * empty identity, exactly like getCart's cartToken. */ favoritesToken: string; /** Pass this back as `listId` to removeFromFavorites to target THIS list, * omitting it always targets the identity's one selected list. */ listId: string; name: string | null; isSelected: boolean; quantity: number; updatedAt: string | null; items: IkeaFavoritesItem[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/removeFromFavoritesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.removeFromFavorites({ itemNo: "<itemNo>", favoritesToken: "<favoritesToken>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.removeFromFavorites({"itemNo": "<itemNo>", "favoritesToken": "<favoritesToken>"}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/removeFromFavorites \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"<itemNo>","favoritesToken":"<favoritesToken>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.removeFromFavorites({ itemNo: "<itemNo>", favoritesToken: "<favoritesToken>" });updateCartItemChanges the quantity of an item already in a cart.Arguments
Name Type Required itemNostringAn itemNo already in the cart.Yes quantitynumberYes cartTokenstringThe cartToken the cart was created or last read with.Yes Returns
IkeaCart & { checkout: IkeaCheckoutHandoff }interface IkeaCartItem { itemNo: string; quantity: number; price: number | null; } interface IkeaCart { /** Pass this back as `cartToken` to getCart, updateCartItem and removeFromCart * to keep working with THIS cart, omitting it always starts a new, empty one. */ cartToken: string; cartId: string; empty: boolean; items: IkeaCartItem[]; quantity: number; updatedAt: string | null; // Where the PERSON finishes: the first item's product page with every item listed to add again (the cart is a guest cart no link can open); a refusal when the cart is empty. Bowmark never checks out. checkout: IkeaCheckoutHandoff; } // The checkout handoff: where the PERSON finishes. Bowmark never pays, books or orders. // Switch on `status`; a status you do not recognise means "show the person `url` and stop". interface IkeaCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; // the https page to open on the site urlKind?: "carries_items" | "signed_in_cart" | "product_page"; // ready_to_checkout only: does the link carry the items, or only open the item's page reason?: string; // unavailable only: out_of_stock | not_available_for_dates | not_sold_online | region_not_served | quantity_unavailable | empty_cart detail?: string; // unavailable only: one sentence saying why account: { site: string; hint: string; signedInAs?: string }; summary: { items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[]; total: string | null; currency: string } | null; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/updateCartItemCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.updateCartItem({ itemNo: "<itemNo>", quantity: 1, cartToken: "<cartToken>" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.updateCartItem({ "itemNo": "<itemNo>", "quantity": 1, "cartToken": "<cartToken>" }))curl -X POST https://api.bowmark.ai/v1/sites/ikea/updateCartItem \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"itemNo":"<itemNo>","quantity":1,"cartToken":"<cartToken>"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.updateCartItem({ itemNo: "<itemNo>", quantity: 1, cartToken: "<cartToken>" });updateProfileEdits the signed-in caller's own IKEA personal details.Arguments
Name Type Required firstNamestringOnly the fields passed are changed.No lastNamestringNo birthDatestringYYYY-MM-DD.No genderCodestringIKEA's gender code, e.g. "MALE", "FEMALE", "NOTSET".No Returns
IkeaProfileUpdateResultinterface IkeaProfileUpdateResult { updated: boolean; /** The fields that were sent. */ fields: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/ikea/updateProfileCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.ikea.updateProfile({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.ikea.updateProfile({}))curl -X POST https://api.bowmark.ai/v1/sites/ikea/updateProfile \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.ikea.updateProfile({});
Use it from code
- Node
npm i @bowmark/web - Python
pip install bowmark-web - HTTP
POST /v1/sites/ikea/<function> - OpenAPI
/v1/sites/ikea/openapi.json