{"openapi":"3.1.0","info":{"title":"Mango API (Bowmark)","version":"e833508f87ff","description":"Mango (mango.com) fashion store, US catalog by default or the Canadian store (country: \"ca\", CAD prices). Lists a men's/women's category (sweaters, shirts, jeans…) with per-color price, sale compare-at price and per-size stock, filtered by size, on-sale and in-stock; and reads one product's variant sizes, prices and live stock.\n\nEvery function Bowmark has for Mango (mango.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/mango/listCategories":{"post":{"operationId":"listCategories","summary":"Lists the Mango catalog categories (men's sweaters and cardigans, shirts, jeans, women's dresses…) with the ids searchProducts takes; the same ids serve the US and Canadian stores.","description":"Lists the Mango catalog categories (men's sweaters and cardigans, shirts, jeans, women's dresses…) with the ids searchProducts takes; the same ids serve the US and Canadian stores.\n\nCalls `bowmark.providers.mango.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MangoCategory[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/mango/searchProducts":{"post":{"operationId":"searchProducts","summary":"Searches Mango's apparel catalog for what a shopper asks (\"men's sweater\", \"long sleeve shirt\") and returns each product with variant sizes, sale and compare-at prices and per-size stock — filterable ","description":"Searches Mango's apparel catalog for what a shopper asks (\"men's sweater\", \"long sleeve shirt\") and returns each product with variant sizes, sale and compare-at prices and per-size stock — filterable to a size, on-sale and in-stock only, paged past 60 with offset/nextOffset (hasMore says the category goes on), from the US store or the Canadian one (country: \"ca\", CAD). The way in; returns the productId getProduct takes.\n\nCalls `bowmark.providers.mango.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MangoSearchResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"$ref":"#/components/schemas/MangoSearchArgs"},{"type":"string"}],"description":"TypeScript: `MangoSearchArgs | string`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/mango/getProduct":{"post":{"operationId":"getProduct","summary":"Reads one Mango product's colors and sizes with each color's price, compare-at price, discount, live per-size stock and photos (model, flat, close-up, swatch), so a sold-out size is never shown.","description":"Reads one Mango product's colors and sizes with each color's price, compare-at price, discount, live per-size stock and photos (model, flat, close-up, swatch), so a sold-out size is never shown. Takes the 8-digit reference, the product URL, or a searchProducts hit (which keeps its US or Canadian store).\n\nCalls `bowmark.providers.mango.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MangoProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/MangoProduct"},{"type":"object","properties":{"productId":{"type":"string"},"country":{"$ref":"#/components/schemas/MangoCountry"}},"required":["productId"],"additionalProperties":true}],"description":"TypeScript: `string | MangoProduct | { productId: string; country?: MangoCountry }`"}},"required":["productId"],"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":{"$ref":"#/components/schemas/MangoProduct"}}}]}}}},"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}}},"MangoColor":{"type":"object","properties":{"colorId":{"type":"string"},"label":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"null"}]},"compareAtPrice":{"anyOf":[{"type":"number"},{"type":"null"}]},"discountPercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"onSale":{"type":"boolean"},"sizes":{"type":"array","items":{"$ref":"#/components/schemas/MangoSize"}},"imageUrl":{"type":"string"},"images":{"$ref":"#/components/schemas/MangoImages"}},"required":["colorId","label","price","compareAtPrice","discountPercent","onSale","sizes","imageUrl","images"],"additionalProperties":true},"MangoCountry":{"anyOf":[{"const":"us"},{"const":"ca"}]},"MangoImages":{"type":"object","properties":{"model":{"type":"array","items":{"type":"string"}},"flat":{"type":"string"},"detail":{"type":"string"},"swatch":{"type":"string"}},"required":["model","flat","detail","swatch"],"additionalProperties":true},"MangoProduct":{"type":"object","properties":{"productId":{"type":"string"},"country":{"$ref":"#/components/schemas/MangoCountry"},"currency":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"model":{"anyOf":[{"type":"string"},{"type":"null"}]},"collection":{"anyOf":[{"type":"string"},{"type":"null"}]},"gender":{"anyOf":[{"type":"string"},{"type":"null"}]},"families":{"type":"array","items":{"type":"string"}},"colors":{"type":"array","items":{"$ref":"#/components/schemas/MangoColor"}},"minPrice":{"anyOf":[{"type":"number"},{"type":"null"}]},"onSale":{"type":"boolean"},"inStock":{"type":"boolean"}},"required":["productId","country","currency","name","url","model","collection","gender","families","colors","minPrice","onSale","inStock"],"additionalProperties":true},"MangoSearchArgs":{"type":"object","properties":{"query":{"type":"string"},"category":{"type":"string"},"gender":{"anyOf":[{"const":"men"},{"const":"women"},{"const":"kids"}]},"size":{"type":"string"},"onSaleOnly":{"type":"boolean"},"inStockOnly":{"type":"boolean"},"limit":{"type":"number"},"offset":{"type":"number"},"country":{"$ref":"#/components/schemas/MangoCountry"}},"additionalProperties":true},"MangoSize":{"type":"object","properties":{"sizeId":{"type":"string"},"label":{"type":"string"},"inStock":{"type":"boolean"},"lastUnits":{"type":"boolean"}},"required":["sizeId","label","inStock","lastUnits"],"additionalProperties":true}}}}