{"openapi":"3.1.0","info":{"title":"Sears API (Bowmark)","version":"e833508f87ff","description":"Sears' own storefront — product search, product detail, fulfillment/stock and store locator.\n\nEvery function Bowmark has for Sears (sears.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/sears/search":{"post":{"operationId":"search","summary":"Searches Sears' live catalog by free-text keyword the way the site's own search bar does, returning matching product rows: id, name, brand, current and regular price, a thumbnail, rating/review count ","description":"Searches Sears' live catalog by free-text keyword the way the site's own search bar does, returning matching product rows: id, name, brand, current and regular price, a thumbnail, rating/review count and the site's own total match count. A query with no matches returns an empty array — Sears not carrying something is a real, common answer, not an error. `zipCode` narrows price/availability the way the site's own zip cookie does; omit it for the site's own default (New York, 10101). Returns one page (up to 48 rows); the site publishes no further paging parameter this function reaches.\n\nCalls `bowmark.providers.sears.search`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SearsSearchResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/SearsSearchQuery","description":"TypeScript: `SearsSearchQuery`"}},"required":["query"],"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/sears/getProduct":{"post":{"operationId":"getProduct","summary":"Reads one Sears product in full: name, brand, current and regular price, whether it's in stock, every image and the site's own full labelled spec sheet (dimensions, features, overview).","description":"Reads one Sears product in full: name, brand, current and regular price, whether it's in stock, every image and the site's own full labelled spec sheet (dimensions, features, overview). Takes the product id or full URL from Sears's own \"/p-<id>\" pattern — `search` returns both, so the ordinary path is a `search` row's `id` or `url`. `zipCode` narrows price/availability the way the site's own zip cookie does; omit it for the site's own default (New York, 10101). THROWS on an id the site does not recognise.\n\nCalls `bowmark.providers.sears.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SearsProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"zipCode":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ zipCode?: string }`"}},"required":["idOrUrl"],"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/sears/checkStock":{"post":{"operationId":"checkStock","summary":"Answers whether a Sears product is buyable right now — for shipping/delivery AND for in-store/curbside pickup — the way the product page's own fulfillment panel does, in one call.","description":"Answers whether a Sears product is buyable right now — for shipping/delivery AND for in-store/curbside pickup — the way the product page's own fulfillment panel does, in one call. `shipping` carries the site's own available quantity, ship modes and promise date. `pickup.stores` is the stores the site found able to fulfil it near `zipCode` — routinely empty (Sears' physical footprint has shrunk sharply), which is a real, common answer, not an error; `pickup.message` carries the site's own explanation when it is. `zipCode` narrows the search the way the site's own zip cookie does; omit it for the site's own default (New York, 10101). Takes the product id or URL from `search`/`getProduct` — same as `getProduct`.\n\nCalls `bowmark.providers.sears.checkStock`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<SearsStock>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"idOrUrl":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"zipCode":{"type":"string"},"quantity":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ zipCode?: string; quantity?: number }`"}},"required":["idOrUrl"],"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}}},"SearsSearchQuery":{"type":"object","properties":{"query":{"type":"string"},"zipCode":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true}}}}