{"openapi":"3.1.0","info":{"title":"Amazon API (Bowmark)","version":"bc1511aab02c","description":"Search Amazon's catalogue and read a product the way a shopper does — price, stock, rating, the customer reviews, the other products it recommends, every size and colour the listing sells, when it would arrive at a given ZIP — plus the rankings (best sellers, new releases, movers and shakers, most wished for), today's deals, a marketplace seller's feedback and the anonymous guest cart, which a caller can now add to. searchProducts, searchWholeFoods, suggestKeywords, listBestSellerCategories, getProduct, listVariations, listReviews, getReviewSummary, listRelatedProducts, listBestSellers, listNewReleases, listMostWishedFor, listDeals, getSeller, getDeliveryEstimate, listSellerOffers, getCart and addToCart are built; everything else is still a declared stub. Also answers for Amazon's country stores: pass `market` ('in', 'com.br', 'ca', 'co.uk', 'de', 'com.mx') or a URL on that store, and prices come back in its own currency.\n\nEvery function Bowmark has for Amazon (www.amazon.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/amazon/searchProducts":{"post":{"operationId":"searchProducts","summary":"Paginate through Amazon search results by keyword using the page parameter to reach rows 49+, 97+, and beyond.","description":"Paginate through Amazon search results by keyword using the page parameter to reach rows 49+, 97+, and beyond. Takes `{ keywords: string }` — `query` is accepted as an alias for `keywords`, since that is the name most other search tools use. searchProducts({keywords, page}) returns a full result total count (e.g., \"48 of 6476 total results\") so a caller knows how many results exist and can keep paging. Pass page 2 to get rows 49-96, page 3 for rows 97-144, etc. Returns `{ products, totalResultCount }` — the array is `products`, NOT `results` — and each row is `{ asin, title, url, price, listPrice, rating, ratingCount, sponsored, image }`: `rating` is the 0-5 star average and `ratingCount` how many ratings it is over (there is no `reviewCount` or `starRating`), so rank the top-rated on those two and skip `sponsored` rows. Search Amazon's catalogue for what a person would type — \"cast iron skillet\", \"usb c hub\" — and get back the result cards as the site ranks them. The page parameter is fully supported: page 2 returns rows 49-96 (a genuinely different set, not page one repeated), page 3 returns rows 97-144, and you can continue paging to reach all 6000+ results. The totalResultCount field tells you how many total rows exist so you can page efficiently. Optionally narrowed to a department, a brand, a price range, a sort order. THE provider's door: every function below that takes an ASIN is fed by this one.\n\nCalls `bowmark.providers.amazon.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonSearchResult>`.","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/amazon/searchWholeFoods":{"post":{"operationId":"searchWholeFoods","summary":"Search Whole Foods Market groceries sold on amazon.com — \"organic bananas\", \"sourdough bread\" — and get the product cards with their current price and list price.","description":"Search Whole Foods Market groceries sold on amazon.com — \"organic bananas\", \"sourdough bread\" — and get the product cards with their current price and list price. Same return shape as searchProducts: `{ products, totalResultCount }`, each row `{ asin, title, url, price, listPrice, rating, ratingCount, sponsored, image }`; feed an `asin` to getProduct for detail. Optional `sort` (e.g. \"price-asc-rank\") and `page`. Prices are Amazon's national Whole Foods prices, not one store's: picking a store needs a signed-in Prime address. Never places an order.\n\nCalls `bowmark.providers.amazon.searchWholeFoods`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchWholeFoodsArgs","description":"TypeScript: `SearchWholeFoodsArgs`"}},"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/amazon/listCategoryProducts":{"post":{"operationId":"listCategoryProducts","summary":"Browse a whole department with no keyword at all — \"what is in Home & Kitchen, best-reviewed first\" — and page through it, sorted the way searchProducts sorts.","description":"Browse a whole department with no keyword at all — \"what is in Home & Kitchen, best-reviewed first\" — and page through it, sorted the way searchProducts sorts. Returns the department Amazon actually searched (never the caller's slug echoed back — a department slug can resolve to a DIFFERENT department than the same word means to listBestSellers) beside the product rows. The function a caller reaches for when it has a category rather than a product in mind.\n\nCalls `bowmark.providers.amazon.listCategoryProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonCategoryListing>`.","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/amazon/suggestKeywords":{"post":{"operationId":"suggestKeywords","summary":"Ask Amazon's own search box what it would autocomplete a prefix to — \"cast iron\" comes back as \"cast iron skillets\", \"cast iron\", \"cast iron dutch oven\".","description":"Ask Amazon's own search box what it would autocomplete a prefix to — \"cast iron\" comes back as \"cast iron skillets\", \"cast iron\", \"cast iron dutch oven\". What an agent holding a vague noun calls before it commits to a search, and the cheapest call in the provider.\n\nCalls `bowmark.providers.amazon.suggestKeywords`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonKeywordSuggestion[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["prefix"],"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/amazon/listBestSellerCategories":{"post":{"operationId":"listBestSellerCategories","summary":"List the departments Amazon publishes Best Sellers rankings for — Electronics, Kitchen & Dining, Books, roughly forty of them — each with the slug (\"electronics\", \"kitchen\", \"books\") that listBestSell","description":"List the departments Amazon publishes Best Sellers rankings for — Electronics, Kitchen & Dining, Books, roughly forty of them — each with the slug (\"electronics\", \"kitchen\", \"books\") that listBestSellers, listNewReleases, listMostWishedFor and listMoversAndShakers take. The door for all four ranking functions: a caller holding the word \"kitchen\" cannot reach a ranking without this.\n\nCalls `bowmark.providers.amazon.listBestSellerCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonBestSellerCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"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/amazon/getProduct":{"post":{"operationId":"getProduct","summary":"Read one product page the way a shopper reads it: title, brand, ASIN, current price and list price, whether it is in stock, the star rating and how many ratings it has, the bullet-point features, the ","description":"Read one product page the way a shopper reads it: title, brand, ASIN, current price and list price, whether it is in stock, the star rating and how many ratings it has, the bullet-point features, the specification table, the images, its category breadcrumb, its Best Sellers Rank, and who it is sold by. The single most-wanted read on the whole site.\n\nCalls `bowmark.providers.amazon.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonProductDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/listVariations":{"post":{"operationId":"listVariations","summary":"List every version of a product that is really the same listing — the 8-inch, 10.25-inch, 12-inch and 15-inch skillet; the colours; the pack sizes — each with the ASIN that buys it.","description":"List every version of a product that is really the same listing — the 8-inch, 10.25-inch, 12-inch and 15-inch skillet; the colours; the pack sizes — each with the ASIN that buys it. What an agent needs when the person said \"the 12 inch one\" and the search returned whichever size Amazon ranked first. Empty when the listing has no variations — a real answer, not a parse failure.\n\nCalls `bowmark.providers.amazon.listVariations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonVariation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/listReviews":{"post":{"operationId":"listReviews","summary":"Read what customers actually wrote about a product — reviewer name, star rating, headline, date, the variant they bought, whether the purchase was Verified, the review body, and how many people found ","description":"Read what customers actually wrote about a product — reviewer name, star rating, headline, date, the variant they bought, whether the purchase was Verified, the review body, and how many people found it helpful. Amazon shows a logged-out visitor up to eight reviews on the product page on some products; since November 2026 most product pages show logged-out visitors none, and this refuses with a sign-in error naming getReviewSummary rather than answer an empty list. Sorting, filtering and paging need a signed-in account. The read an agent needs to answer \"is this any good\" rather than \"what does it cost\".\n\nCalls `bowmark.providers.amazon.listReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonReview[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/getReviewSummary":{"post":{"operationId":"getReviewSummary","summary":"What reviewers say about a product, as Amazon shows it to a shopper who is not logged in: the star rating, the rating count, the percent at each star, the \"Customers say\" paragraph, and each aspect Am","description":"What reviewers say about a product, as Amazon shows it to a shopper who is not logged in: the star rating, the rating count, the percent at each star, the \"Customers say\" paragraph, and each aspect Amazon scores (size, ease of cleaning, weight, …) with its sentiment, how many reviews mention it, a one-line summary and real review excerpts with their ids. The answer to \"is this any good\" on the products where Amazon no longer shows individual reviews logged out.\n\nCalls `bowmark.providers.amazon.getReviewSummary`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonReviewSummary>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/listRelatedProducts":{"post":{"operationId":"listRelatedProducts","summary":"The other products Amazon puts next to this one — \"Frequently bought together\" and \"Customers who viewed this item also viewed\" — each with its ASIN, title, price and rating, kept in separate arrays s","description":"The other products Amazon puts next to this one — \"Frequently bought together\" and \"Customers who viewed this item also viewed\" — each with its ASIN, title, price and rating, kept in separate arrays so a caller can tell a complement from a substitute. Names any further rail Amazon lazy-loads rather than serving inline rather than silently dropping it. How an agent moves from one product to the alternatives without inventing a new search query.\n\nCalls `bowmark.providers.amazon.listRelatedProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonRelatedProducts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/listBestSellers":{"post":{"operationId":"listBestSellers","summary":"Amazon's hourly-updated top sellers in one department (the slug listBestSellerCategories returns, e.g.","description":"Amazon's hourly-updated top sellers in one department (the slug listBestSellerCategories returns, e.g. \"kitchen\") — each row's ASIN, rank, title, price and rating, in rank order. What is actually selling right now, as opposed to searchProducts' relevance ranking. Takes a bare department slug, or { department, page } for a second page: page 2 returns ranks 51-80, NOT contiguous with page 1's 1-30 — ranks 31-50 and 81-100 are never rendered on either page. Only these two pages are available on the site.\n\nCalls `bowmark.providers.amazon.listBestSellers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonBestSellerEntry[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ListBestSellersArgs"}],"description":"TypeScript: `string | ListBestSellersArgs`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"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/amazon/listNewReleases":{"post":{"operationId":"listNewReleases","summary":"What is newly out in a department (the slug listBestSellerCategories returns, e.g.","description":"What is newly out in a department (the slug listBestSellerCategories returns, e.g. \"kitchen\"), in Amazon's own hot-new-releases order — each row's ASIN, rank, title, price and rating. The ranking a caller wants when \"best seller\" would only ever return the same entrenched products. Takes a bare department slug, or { department, page } for a second page: page 2 returns ranks 51-80, the same non-contiguous window listBestSellers carries and for the same reason.\n\nCalls `bowmark.providers.amazon.listNewReleases`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonBestSellerEntry[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ListBestSellersArgs"}],"description":"TypeScript: `string | ListBestSellersArgs`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"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/amazon/listMostWishedFor":{"post":{"operationId":"listMostWishedFor","summary":"What people in a department (the slug listBestSellerCategories returns, e.g.","description":"What people in a department (the slug listBestSellerCategories returns, e.g. \"kitchen\") are adding to wish lists and registries most — each row's ASIN, rank, title, price and rating. Demand that has not turned into a purchase yet, which is a different signal from listBestSellers' sales rank. Page one only (up to 30 rows), the same limit the other rankings carry.\n\nCalls `bowmark.providers.amazon.listMostWishedFor`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonBestSellerEntry[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["department"],"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/amazon/listDeals":{"post":{"operationId":"listDeals","summary":"Today's Deals — what is discounted right now: ASIN, title, the deal price, the price it was, the percentage off, and any \"limited time\" wording (a plain label, or, for a countdown deal, the fragment p","description":"Today's Deals — what is discounted right now: ASIN, title, the deal price, the price it was, the percentage off, and any \"limited time\" wording (a plain label, or, for a countdown deal, the fragment plus its ISO deadline). Read off the page's own widget JSON rather than scraped from a card, so the discount is a published field rather than something to compute. Page one only (30 deals) — the site's own paging control was not found this pass.\n\nCalls `bowmark.providers.amazon.listDeals`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonDeal[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"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/amazon/getSeller":{"post":{"operationId":"getSeller","summary":"Read a marketplace seller's storefront — their name, feedback across four windows (30 days, 90 days, the last 12 months and lifetime), the one positive-percentage figure Amazon publishes (last 12 mont","description":"Read a marketplace seller's storefront — their name, feedback across four windows (30 days, 90 days, the last 12 months and lifetime), the one positive-percentage figure Amazon publishes (last 12 months only), their registered business name and address, and their free-text \"About Seller\" text. What tells an agent whether the cheap third-party offer is from a shop with 86,000 ratings or one with thirty. The door is getProduct's sellerId field — a listing Amazon sells itself has none.\n\nCalls `bowmark.providers.amazon.getSeller`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonSeller>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sellerId":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["sellerId"],"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/amazon/getDeliveryEstimate":{"post":{"operationId":"getDeliveryEstimate","summary":"When a product would actually arrive at a given US ZIP, and what it costs to get it there — sets the ZIP for one session (Amazon's own \"glow\" location picker, no account needed) and reads the delivery","description":"When a product would actually arrive at a given US ZIP, and what it costs to get it there — sets the ZIP for one session (Amazon's own \"glow\" location picker, no account needed) and reads the delivery block the product page then re-renders for it: the site's own delivery sentence, the price label and the condition it attaches, plus `options` — every shipping option the buy box offers (standard, and the fastest Prime / paid same-day or next-day promise with its order-by cutoff), each with its own date and price. `zipResolved` is false, and the three fields are Amazon's DEFAULT location rather than the caller's ZIP, on an invalid ZIP.\n\nCalls `bowmark.providers.amazon.getDeliveryEstimate`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonDeliveryEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetDeliveryEstimateArgs","description":"TypeScript: `GetDeliveryEstimateArgs`"}},"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/amazon/listSellerOffers":{"post":{"operationId":"listSellerOffers","summary":"Every seller offering the same listing side by side — condition (new, used, its grade), price, shipping cost and estimate, and the seller's own name, id and star rating — read off the site's \"All Offe","description":"Every seller offering the same listing side by side — condition (new, used, its grade), price, shipping cost and estimate, and the seller's own name, id and star rating — read off the site's \"All Offers Display\" modal rather than the buy-box winner alone. What tells an agent who has it cheapest, and whether the cheap one is Amazon itself or a thirty-rating marketplace seller. Page one only (up to 10 offers, `totalOfferCount` reports the site's own full count) — no paging control was found in the modal's static markup this pass. Empty `offers` on a listing with no other sellers is a real answer, not a parse failure.\n\nCalls `bowmark.providers.amazon.listSellerOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonSellerOffersResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"type":"string","description":"TypeScript: `string`"},"options":{"$ref":"#/components/schemas/AmazonMarketOptions","description":"TypeScript: `AmazonMarketOptions`"}},"required":["asinOrUrl"],"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/amazon/getCart":{"post":{"operationId":"getCart","summary":"Read what is in the cart — the same cart `addToCart` writes.","description":"Read what is in the cart — the same cart `addToCart` writes. With the caller's connected Amazon login (the default one, or `{ connection }` naming it) that is the signed-in account's own cart; with none it is this run's anonymous guest cart, which needs no account. `readAs` says which. Reads the site's own per-row markup (`data-asin`, `data-producttitle`, `data-quantity`, `data-price`) for a populated cart, and the site's own `#sc-empty-cart` block for an empty one. A cart with items also returns a checkout handoff URL (`checkout`): Amazon's add-to-cart link carrying every row, plus which account to sign in as. Bowmark never places the order.\n\nCalls `bowmark.providers.amazon.getCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ connection?: string }`"}},"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/amazon/addToCart":{"post":{"operationId":"addToCart","summary":"Add a product to the cart and hand back a checkout link for everything the cart now holds; Bowmark never places the order and never reaches checkout or payment.","description":"Add a product to the cart and hand back a checkout link for everything the cart now holds; Bowmark never places the order and never reaches checkout or payment. No account needed: anonymously it writes a guest cart and `checkout.url` is Amazon's own add-to-cart link carrying every cart row and the quantity asked for, to open in the person's own signed-in browser. With the caller's connected Amazon login (the default one, or addToCart(asin, { connection })) it writes that account's own cart and `checkout.url` is the cart page (`signed_in_cart` when the account name is known, `needs_login` when it is not), never a link that would add the items a second time; `readAs` says which cart answered. Amazon's cart takes one unit per add, so a signed-in quantity above 1 comes with a warning to set it in the cart. `checkout.status` is \"unavailable\" with a reason (out_of_stock, region_not_served, not_sold_online) when it cannot be bought as asked.\n\nCalls `bowmark.providers.amazon.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AmazonCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asinOrUrl":{"anyOf":[{"type":"string"},{"type":"object","properties":{"asin":{"type":"string"},"quantity":{"type":"number"}},"required":["asin"],"additionalProperties":true},{"type":"object","properties":{"product":{"anyOf":[{"type":"string"},{"type":"object","properties":{"asin":{"type":"string"}},"required":["asin"],"additionalProperties":true}]},"quantity":{"type":"number"}},"required":["product"],"additionalProperties":true},{"type":"object","properties":{"url":{"type":"string"},"quantity":{"type":"number"}},"required":["url"],"additionalProperties":true}],"description":"TypeScript: `string | { asin: string; quantity?: number } | { product: string | { asin: string }; quantity?: number } | { url: string; quantity?: number }`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ connection?: string }`"}},"required":["asinOrUrl"],"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/amazon/listOrders":{"post":{"operationId":"listOrders","summary":"The signed-in customer's own Amazon orders, newest first — order id, date placed, Amazon's own status words (a cancelled or refunded order keeps them), total, item count and the order's page.","description":"The signed-in customer's own Amazon orders, newest first — order id, date placed, Amazon's own status words (a cancelled or refunded order keeps them), total, item count and the order's page. Pages with `nextCursor`. Reads Your Orders through the caller's own browser via Bowmark Buddy; with no sign-in the run pauses for one, never answers [].\n\nCalls `bowmark.providers.amazon.listOrders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SignedInOrderPage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"limit":{"type":"number"},"cursor":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ limit?: number; cursor?: string }`"},"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"}}}}}}}},"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}}},"AmazonMarket":{"anyOf":[{"const":"com"},{"const":"in"},{"const":"com.br"},{"const":"ca"},{"const":"co.uk"},{"const":"de"},{"const":"fr"},{"const":"com.mx"}]},"AmazonMarketOptions":{"type":"object","properties":{"market":{"$ref":"#/components/schemas/AmazonMarket"}},"additionalProperties":true},"GetDeliveryEstimateArgs":{"type":"object","properties":{"product":{"type":"string"},"asin":{"type":"string"},"zip":{"type":"string"}},"required":["zip"],"additionalProperties":true},"ListBestSellersArgs":{"type":"object","properties":{"market":{"$ref":"#/components/schemas/AmazonMarket"},"department":{"type":"string"},"page":{"type":"number"}},"required":["department"],"additionalProperties":true},"ListCategoryProductsArgs":{"type":"object","properties":{"market":{"$ref":"#/components/schemas/AmazonMarket"},"department":{"type":"string"},"sort":{"type":"string"},"page":{"type":"number"}},"required":["department"],"additionalProperties":true},"SearchProductsArgs":{"anyOf":[{"type":"object","properties":{"market":{"$ref":"#/components/schemas/AmazonMarket"},"keywords":{"type":"string"},"department":{"type":"string"},"sort":{"type":"string"},"priceMin":{"type":"number"},"priceMax":{"type":"number"},"brand":{"type":"string"},"page":{"type":"number"}},"required":["keywords"],"additionalProperties":true},{"type":"object","properties":{"market":{"$ref":"#/components/schemas/AmazonMarket"},"query":{"type":"string"},"department":{"type":"string"},"sort":{"type":"string"},"priceMin":{"type":"number"},"priceMax":{"type":"number"},"brand":{"type":"string"},"page":{"type":"number"}},"required":["query"],"additionalProperties":true}]},"SearchWholeFoodsArgs":{"type":"object","properties":{"keywords":{"type":"string"},"sort":{"type":"string"},"page":{"type":"number"}},"required":["keywords"],"additionalProperties":true}}}}