{"openapi":"3.1.0","info":{"title":"Shop API (Bowmark)","version":"e833508f87ff","description":"Shop (Shopify's shopping app) — search products across every Shopify store, read a product with its variants, reviews and delivery estimate, and browse a store's catalogue, collections, reviews and policies; once a caller signs in, list and track their orders, save products, follow stores and fill a cart up to checkout.\n\nEvery function Bowmark has for Shop (shop.app) 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/shop_app/listSavedProducts":{"post":{"operationId":"listSavedProducts","summary":"Lists the products the signed-in caller has saved (hearted) on Shop — product and variant id, title, price, availability, image and store — a page at a time.","description":"Lists the products the signed-in caller has saved (hearted) on Shop — product and variant id, title, price, availability, image and store — a page at a time. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.listSavedProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppSavedProducts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppListPageArgs","description":"TypeScript: `ShopAppListPageArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/listProductLists":{"post":{"operationId":"listProductLists","summary":"Lists the signed-in caller's own Shop collections (wishlists) — id, name, public share id, privacy, cover image and a preview of the items — a page at a time.","description":"Lists the signed-in caller's own Shop collections (wishlists) — id, name, public share id, privacy, cover image and a preview of the items — a page at a time. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.listProductLists`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppProductLists>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppListPageArgs","description":"TypeScript: `ShopAppListPageArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/getCart":{"post":{"operationId":"getCart","summary":"Reads the signed-in caller's Shop cart — one cart per store, each with its lines (variant, title, quantity, price) and the store's checkout url — and the total item count.","description":"Reads the signed-in caller's Shop cart — one cart per store, each with its lines (variant, title, quantity, price) and the store's checkout url — and the total item count. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.getCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/listFollowedStores":{"post":{"operationId":"listFollowedStores","summary":"Lists the stores the signed-in caller follows on Shop — store id, name and logo — a page at a time.","description":"Lists the stores the signed-in caller follows on Shop — store id, name and logo — a page at a time. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.listFollowedStores`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppFollowedStores>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppListPageArgs","description":"TypeScript: `ShopAppListPageArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/addAddress":{"post":{"operationId":"addAddress","summary":"Adds a shipping address to the signed-in caller's Shop account (country is a two-letter code) and returns it as listAddresses shows it.","description":"Adds a shipping address to the signed-in caller's Shop account (country is a two-letter code) and returns it as listAddresses shows it. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.addAddress`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppAddress>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppAddAddressArgs","description":"TypeScript: `ShopAppAddAddressArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/createProductList":{"post":{"operationId":"createProductList","summary":"Creates a new named product list on the signed-in caller's Shop account (private unless privacy: \"PUBLIC\") and returns its id — the id listProductLists shows.","description":"Creates a new named product list on the signed-in caller's Shop account (private unless privacy: \"PUBLIC\") and returns its id — the id listProductLists shows. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.createProductList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppCreatedProductList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppCreateProductListArgs","description":"TypeScript: `ShopAppCreateProductListArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/saveProduct":{"post":{"operationId":"saveProduct","summary":"Saves a product variant to the signed-in caller's Shop favourites (or removes it with saved: false), by its numeric variant id and the store selling it.","description":"Saves a product variant to the signed-in caller's Shop favourites (or removes it with saved: false), by its numeric variant id and the store selling it. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.saveProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppListItemState>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppSaveProductArgs","description":"TypeScript: `ShopAppSaveProductArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/addToProductList":{"post":{"operationId":"addToProductList","summary":"Adds a product variant to one of the signed-in caller's Shop lists (listProductLists' or createProductList's id), or removes it with remove: true.","description":"Adds a product variant to one of the signed-in caller's Shop lists (listProductLists' or createProductList's id), or removes it with remove: true. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.addToProductList`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppListItemState>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppAddToProductListArgs","description":"TypeScript: `ShopAppAddToProductListArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/addToCart":{"post":{"operationId":"addToCart","summary":"Adds a product variant (getProduct / getVariant's id) to the signed-in caller's Shop cart at its store, quantity 1 by default.","description":"Adds a product variant (getProduct / getVariant's id) to the signed-in caller's Shop cart at its store, quantity 1 by default. Stops at the cart: startCheckout opens the checkout and nothing here pays. Returns `checkout`: Shop's own cart page and which account to sign in to. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.addToCart`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppAddedToCart>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppAddToCartArgs","description":"TypeScript: `ShopAppAddToCartArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/listAddresses":{"post":{"operationId":"listAddresses","summary":"Lists the signed-in caller's saved shipping addresses on Shop, with the one Shop prefers marked.","description":"Lists the signed-in caller's saved shipping addresses on Shop, with the one Shop prefers marked. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.listAddresses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppAddressList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/getShopCash":{"post":{"operationId":"getShopCash","summary":"Reads the signed-in caller's spendable Shop Cash balance and its currency.","description":"Reads the signed-in caller's spendable Shop Cash balance and its currency. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.getShopCash`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppShopCash>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/getAccount":{"post":{"operationId":"getAccount","summary":"Reads the caller's Shop account settings: whether they opted out of data sharing, and the country and EU status Shop resolved for them.","description":"Reads the caller's Shop account settings: whether they opted out of data sharing, and the country and EU status Shop resolved for them. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.getAccount`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppAccount>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/startCheckout":{"post":{"operationId":"startCheckout","summary":"Opens a checkout for the signed-in caller's Shop cart at one store (its Shop id or handle) and returns the checkout url for the caller to review and pay.","description":"Opens a checkout for the signed-in caller's Shop cart at one store (its Shop id or handle) and returns the checkout url for the caller to review and pay. Never pays — it stops before payment, always. Also returns `checkout`: the same page with which account to sign in to. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.startCheckout`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppCheckout>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppStartCheckoutArgs","description":"TypeScript: `ShopAppStartCheckoutArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/followStore":{"post":{"operationId":"followStore","summary":"Follows a store on Shop for the signed-in caller (or unfollows it with follow: false) by its Shop store id — listFollowedStores' id — or its handle, and returns the new follow state.","description":"Follows a store on Shop for the signed-in caller (or unfollows it with follow: false) by its Shop store id — listFollowedStores' id — or its handle, and returns the new follow state. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.followStore`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppFollowState>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppFollowStoreArgs","description":"TypeScript: `ShopAppFollowStoreArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/markOrderDelivered":{"post":{"operationId":"markOrderDelivered","summary":"Marks one of the signed-in caller's Shop deliveries as delivered (or un-marks it with delivered: false) by the deliveryId trackPackage returns or its shop.app/deliveries/<id> url, and returns the new ","description":"Marks one of the signed-in caller's Shop deliveries as delivered (or un-marks it with delivered: false) by the deliveryId trackPackage returns or its shop.app/deliveries/<id> url, and returns the new state. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.markOrderDelivered`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppDeliveryState>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppMarkDeliveredArgs","description":"TypeScript: `ShopAppMarkDeliveredArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/trackPackage":{"post":{"operationId":"trackPackage","summary":"Adds a package to the signed-in caller's Shop by its tracking number so Shop tracks it — carrier picked from Shop's own suggestions for the number unless given, optional package name and destination p","description":"Adds a package to the signed-in caller's Shop by its tracking number so Shop tracks it — carrier picked from Shop's own suggestions for the number unless given, optional package name and destination postal code — and returns the delivery id and its shop.app link. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.trackPackage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppTrackedPackage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppTrackPackageArgs","description":"TypeScript: `ShopAppTrackPackageArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/getOrder":{"post":{"operationId":"getOrder","summary":"One of the signed-in caller's own Shop orders by the id listOrders returns (or its shop.app/orders/<id> url): store, order number, status, subtotal, shipping, tax and total, the shipping address, ever","description":"One of the signed-in caller's own Shop orders by the id listOrders returns (or its shop.app/orders/<id> url): store, order number, status, subtotal, shipping, tax and total, the shipping address, every item with variant, quantity and price, and each shipment's carrier, tracking code and tracking link. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.getOrder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppOrderDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["id"],"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/shop_app/listOrders":{"post":{"operationId":"listOrders","summary":"The signed-in caller's own Shop orders, newest first — store, status words, delivery and payment status, total, item count and item images — \"active\" (not yet delivered, the default), \"past\" or \"all\",","description":"The signed-in caller's own Shop orders, newest first — store, status words, delivery and payment status, total, item count and item images — \"active\" (not yet delivered, the default), \"past\" or \"all\", or a free-text search across them; a page at a time with nextCursor. Pauses for the caller to sign in to Shop.\n\nCalls `bowmark.providers.shop_app.listOrders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppOrderList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppListOrdersArgs","description":"TypeScript: `ShopAppListOrdersArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/shop_app/getProduct":{"post":{"operationId":"getProduct","summary":"One product by its numeric id or a shop.app/products/<id>/<slug> url: title, description, store, rating, every option axis (\"Color\", \"Size\") with its values, and the selected/first-available variant's","description":"One product by its numeric id or a shop.app/products/<id>/<slug> url: title, description, store, rating, every option axis (\"Color\", \"Size\") with its values, and the selected/first-available variant's own price, stock and image. The door carries only ONE priced variant, not a full per-combination list — pick a different one with getVariant.\n\nCalls `bowmark.providers.shop_app.getProduct`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppProduct>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"TypeScript: `string`"}},"required":["input"],"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/shop_app/getStore":{"post":{"operationId":"getStore","summary":"One store's Shop page by its handle (shop.app/m/<handle>) or a product id from that store: name, logo, description, rating, follower count, and the collection titles the store publishes.","description":"One store's Shop page by its handle (shop.app/m/<handle>) or a product id from that store: name, logo, description, rating, follower count, and the collection titles the store publishes.\n\nCalls `bowmark.providers.shop_app.getStore`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStore>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string","description":"TypeScript: `string`"}},"required":["input"],"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/shop_app/listStoreProducts":{"post":{"operationId":"listStoreProducts","summary":"Lists a store's products — sorted by best-selling, newest or price, filtered to in-stock or by the store's own filters — with id, title, price, image and rating, a page at a time.","description":"Lists a store's products — sorted by best-selling, newest or price, filtered to in-stock or by the store's own filters — with id, title, price, image and rating, a page at a time.\n\nCalls `bowmark.providers.shop_app.listStoreProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStoreProductList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"first":{"type":"number"},"sortBy":{"type":"string"},"search":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ first?: number; sortBy?: string; search?: string }`"}},"required":["handle"],"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/shop_app/suggestSearches":{"post":{"operationId":"suggestSearches","summary":"Autocompletes a partial search (\"running sh\") into Shop's own query suggestions plus the stores whose names match, each store with its handle, logo, rating and review count — the finder that turns a c","description":"Autocompletes a partial search (\"running sh\") into Shop's own query suggestions plus the stores whose names match, each store with its handle, logo, rating and review count — the finder that turns a caller's words into a store handle or a better search phrase.\n\nCalls `bowmark.providers.shop_app.suggestSearches`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppSearchSuggestions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"TypeScript: `string`"}},"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/shop_app/searchStore":{"post":{"operationId":"searchStore","summary":"Searches inside one store for products matching free text (\"strawberry\" in Liquid I.V.), with the store's own alternate query phrases for a miss or a broader match.","description":"Searches inside one store for products matching free text (\"strawberry\" in Liquid I.V.), with the store's own alternate query phrases for a miss or a broader match.\n\nCalls `bowmark.providers.shop_app.searchStore`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStoreSearchResults>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","description":"TypeScript: `string`"},"query":{"type":"string","description":"TypeScript: `string`"}},"required":["handle","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/shop_app/getStoreReviews":{"post":{"operationId":"getStoreReviews","summary":"Lists the reviews left across a whole store — rating, text, product, author and date — with the store's overall rating, a page at a time.","description":"Lists the reviews left across a whole store — rating, text, product, author and date — with the store's overall rating, a page at a time.\n\nCalls `bowmark.providers.shop_app.getStoreReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStoreReviews>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","description":"TypeScript: `string`"},"options":{"type":"object","properties":{"first":{"type":"number"}},"additionalProperties":true,"description":"TypeScript: `{ first?: number }`"}},"required":["handle"],"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/shop_app/getStoreCollection":{"post":{"operationId":"getStoreCollection","summary":"The products in one of a store's named collections (\"Best Sellers\", \"Sugar-Free\") — pass a store handle plus the collection id from getStore's collection titles, or the full shop.app/m/<handle>/collec","description":"The products in one of a store's named collections (\"Best Sellers\", \"Sugar-Free\") — pass a store handle plus the collection id from getStore's collection titles, or the full shop.app/m/<handle>/collections/<id>/<slug> url.\n\nCalls `bowmark.providers.shop_app.getStoreCollection`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStoreCollection>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handleOrUrl":{"type":"string","description":"TypeScript: `string`"},"collectionId":{"type":"string","description":"TypeScript: `string`"}},"required":["handleOrUrl"],"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/shop_app/getVariant":{"post":{"operationId":"getVariant","summary":"Picks one variant of a product by its options ({ Size: \"Large\", Color: \"Powder Blue\" }, one value for EVERY axis getProduct lists) and returns that variant's id, title, price, sale price, availability","description":"Picks one variant of a product by its options ({ Size: \"Large\", Color: \"Powder Blue\" }, one value for EVERY axis getProduct lists) and returns that variant's id, title, price, sale price, availability and image — what a shopper does by tapping options on the product page.\n\nCalls `bowmark.providers.shop_app.getVariant`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppVariant>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppGetVariantArgs","description":"TypeScript: `ShopAppGetVariantArgs`"}},"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/shop_app/listCategories":{"post":{"operationId":"listCategories","summary":"Lists Shop's product categories (Women, Men, Beauty, Home, Fitness, Baby, Food …) — the top level with no argument, or one category's sub-categories given its id — each with the id browseCategory take","description":"Lists Shop's product categories (Women, Men, Beauty, Home, Fitness, Baby, Food …) — the top level with no argument, or one category's sub-categories given its id — each with the id browseCategory takes and whether it has children of its own.\n\nCalls `bowmark.providers.shop_app.listCategories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppCategoryList>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","description":"TypeScript: `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/shop_app/getProductReviews":{"post":{"operationId":"getProductReviews","summary":"A product's reviews, a page at a time — each with its rating, title, text, reviewer name, date, helpful count, the variant bought and any photos — plus the total count and a cursor for the next page; ","description":"A product's reviews, a page at a time — each with its rating, title, text, reviewer name, date, helpful count, the variant bought and any photos — plus the total count and a cursor for the next page; optionally only reviews matching a search phrase.\n\nCalls `bowmark.providers.shop_app.getProductReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppProductReviews>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppGetProductReviewsArgs","description":"TypeScript: `ShopAppGetProductReviewsArgs`"}},"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/shop_app/browseCategory":{"post":{"operationId":"browseCategory","summary":"Browses one Shop product category by the id listCategories returns — its name and breadcrumbs, the sub-categories to drill into, and the products Shop features there, grouped by section (\"T-shirts\", \"","description":"Browses one Shop product category by the id listCategories returns — its name and breadcrumbs, the sub-categories to drill into, and the products Shop features there, grouped by section (\"T-shirts\", \"Hoodies\"), each with price, rating, store and image — with a cursor for more sections.\n\nCalls `bowmark.providers.shop_app.browseCategory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppCategoryFeed>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ShopAppBrowseCategoryArgs","description":"TypeScript: `ShopAppBrowseCategoryArgs`"}},"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/shop_app/getDiscoveryFeed":{"post":{"operationId":"getDiscoveryFeed","summary":"Reads Shop's home discovery feed as a logged-out visitor sees it — shelves of trending stores, deals and each category's trending products, every product with price, rating and store — a page of secti","description":"Reads Shop's home discovery feed as a logged-out visitor sees it — shelves of trending stores, deals and each category's trending products, every product with price, rating and store — a page of sections at a time with a cursor for more.\n\nCalls `bowmark.providers.shop_app.getDiscoveryFeed`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppDiscoveryFeed>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"pageSize":{"type":"number"},"after":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ pageSize?: number; after?: 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/shop_app/searchProducts":{"post":{"operationId":"searchProducts","summary":"Searches every Shopify store on Shop for products matching free text (\"trail running shoes\") — each product's id (for getProduct), title, store, price, image and rating, a page at a time with a cursor","description":"Searches every Shopify store on Shop for products matching free text (\"trail running shoes\") — each product's id (for getProduct), title, store, price, image and rating, a page at a time with a cursor for more.\n\nCalls `bowmark.providers.shop_app.searchProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppProductSearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"anyOf":[{"type":"string"},{"type":"object","properties":{"query":{"type":"string"},"pageSize":{"type":"number"},"after":{"type":"string"}},"required":["query"],"additionalProperties":true}],"description":"TypeScript: `string | { query: string; pageSize?: number; after?: 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/shop_app/listOffers":{"post":{"operationId":"listOffers","summary":"Lists the stores running offers on Shop right now — each store's offer line, the minimum order for its Shop Cash reward, and the discounted products with sale and original price — a page of stores at ","description":"Lists the stores running offers on Shop right now — each store's offer line, the minimum order for its Shop Cash reward, and the discounted products with sale and original price — a page of stores at a time with a cursor for more.\n\nCalls `bowmark.providers.shop_app.listOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppOffers>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"pageSize":{"type":"number"},"after":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ pageSize?: number; after?: 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/shop_app/getStorePolicies":{"post":{"operationId":"getStorePolicies","summary":"Reads a store's refund, shipping and privacy policies as plain text, each with the url Shop serves it from — null for a policy the store does not publish.","description":"Reads a store's refund, shipping and privacy policies as plain text, each with the url Shop serves it from — null for a policy the store does not publish.\n\nCalls `bowmark.providers.shop_app.getStorePolicies`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStorePolicies>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","description":"TypeScript: `string`"}},"required":["handle"],"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/shop_app/getStoreContacts":{"post":{"operationId":"getStoreContacts","summary":"How to reach a store as its Shop page lists it — support email, phone, website and contact page lifted out, every social link in `contacts`, and the business mailing address.","description":"How to reach a store as its Shop page lists it — support email, phone, website and contact page lifted out, every social link in `contacts`, and the business mailing address.\n\nCalls `bowmark.providers.shop_app.getStoreContacts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ShopAppStoreContacts>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","description":"TypeScript: `string`"}},"required":["handle"],"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}}},"ShopAppAddAddressArgs":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"zoneCode":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"},"company":{"type":"string"},"phone":{"type":"string"}},"required":["firstName","lastName","address1","city","country"],"additionalProperties":true},"ShopAppAddToCartArgs":{"type":"object","properties":{"store":{"type":"string"},"variantId":{"type":"string"},"quantity":{"type":"number"},"sellingPlanId":{"type":"string"}},"required":["store","variantId"],"additionalProperties":true},"ShopAppAddToProductListArgs":{"type":"object","properties":{"listId":{"type":"string"},"variantId":{"type":"string"},"store":{"type":"string"},"remove":{"type":"boolean"}},"required":["listId","variantId"],"additionalProperties":true},"ShopAppBrowseCategoryArgs":{"type":"object","properties":{"categoryId":{"type":"string"},"after":{"type":"string"}},"required":["categoryId"],"additionalProperties":true},"ShopAppCreateProductListArgs":{"type":"object","properties":{"name":{"type":"string"},"privacy":{"anyOf":[{"const":"PRIVATE"},{"const":"PUBLIC"}]}},"required":["name"],"additionalProperties":true},"ShopAppFollowStoreArgs":{"type":"object","properties":{"store":{"type":"string"},"follow":{"type":"boolean"}},"required":["store"],"additionalProperties":true},"ShopAppGetProductReviewsArgs":{"type":"object","properties":{"product":{"type":"string"},"first":{"type":"number"},"after":{"type":"string"},"searchQuery":{"type":"string"}},"required":["product"],"additionalProperties":true},"ShopAppGetVariantArgs":{"type":"object","properties":{"product":{"type":"string"},"options":{"type":"object","additionalProperties":{"type":"string"}}},"required":["product","options"],"additionalProperties":true},"ShopAppListOrdersArgs":{"type":"object","properties":{"status":{"anyOf":[{"const":"active"},{"const":"past"},{"const":"all"}]},"query":{"type":"string"},"cursor":{"type":"string"}},"additionalProperties":true},"ShopAppListPageArgs":{"type":"object","properties":{"first":{"type":"number"},"cursor":{"type":"string"}},"additionalProperties":true},"ShopAppMarkDeliveredArgs":{"type":"object","properties":{"deliveryId":{"type":"string"},"delivered":{"type":"boolean"}},"required":["deliveryId"],"additionalProperties":true},"ShopAppSaveProductArgs":{"type":"object","properties":{"variantId":{"type":"string"},"store":{"type":"string"},"saved":{"type":"boolean"}},"required":["variantId"],"additionalProperties":true},"ShopAppStartCheckoutArgs":{"type":"object","properties":{"store":{"type":"string"}},"required":["store"],"additionalProperties":true},"ShopAppTrackPackageArgs":{"type":"object","properties":{"trackingCode":{"type":"string"},"carrier":{"type":"string"},"name":{"type":"string"},"destinationPostalCode":{"type":"string"}},"required":["trackingCode"],"additionalProperties":true}}}}