{"openapi":"3.1.0","info":{"title":"Nuvemshop (BYOK) API","version":"0.1.0","description":"Nuvemshop (BYOK) lets an AI assistant read your own Nuvemshop data through the Nuvemshop API with a key you supply (store access token). Read-only: 10 tools (get_store, list_orders, get_order, list_products, get_product, find_product_by_sku, list_customers, list_categories, list_coupons, list_locations). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-nuvemshop.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-nuvemshop/docs"},"termsOfService":"https://connectorbay.com/byok-nuvemshop/terms"},"servers":[{"url":"https://byok-nuvemshop.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-nuvemshop/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_store":{"post":{"operationId":"get_store","summary":"Show the store: names, main currency and language, country, plan name, domains, contact email and enabled API features. ","description":"Show the store: names, main currency and language, country, plan name, domains, contact email and enabled API features. Use for \"Which plan and currency does my Nuvemshop store use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"}},"required":["store_id"],"title":"get_storeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_orders":{"post":{"operationId":"list_orders","summary":"List orders newest first with number, status, payment status, shipping status, buyer name and email, totals and dates. C","description":"List orders newest first with number, status, payment status, shipping status, buyer name and email, totals and dates. Capped at 10000 matches per query: narrow with dates or status. Use for \"Which Nuvemshop orders are paid but not yet shipped\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"status":{"anyOf":[{"enum":["any","open","closed","cancelled"],"type":"string"},{"type":"null"}],"default":"any","description":"Order state: any (default), open, closed or cancelled.","title":"Status"},"payment_status":{"anyOf":[{"enum":["any","pending","authorized","paid","abandoned","refunded","voided"],"type":"string"},{"type":"null"}],"default":"any","description":"Payment state: any, pending, authorized, paid, abandoned, refunded or voided.","title":"Payment Status"},"shipping_status":{"anyOf":[{"enum":["any","unpacked","unfulfilled","fulfilled"],"type":"string"},{"type":"null"}],"default":"any","description":"Shipping state: any, unpacked, unfulfilled or fulfilled.","title":"Shipping Status"},"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search by order number, or text in the buyer's name or email.","title":"Q"},"created_at_min":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders created after this ISO 8601 date-time, for example 2026-01-01T00:00:00-03:00.","title":"Created At Min"},"updated_at_min":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only orders last updated after this ISO 8601 date-time.","title":"Updated At Min"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API does not paginate unless asked).","title":"Page"},"per_page":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Results per page (1 to 200, default 30).","title":"Per Page"}},"required":["store_id"],"title":"list_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_order":{"post":{"operationId":"get_order","summary":"Get one order by id with buyer, totals, statuses and the purchased products. Use for \"Show Nuvemshop order 871254203\".","description":"Get one order by id with buyer, totals, statuses and the purchased products. Use for \"Show Nuvemshop order 871254203\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"order_id":{"description":"Numeric order id (the id field, not the order number).","maxLength":200,"title":"Order Id","type":"string"}},"required":["store_id","order_id"],"title":"get_orderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_products":{"post":{"operationId":"list_products","summary":"List products with names, handles, visibility, categories and variants (SKU, price, promotional price, stock). Use for \"","description":"List products with names, handles, visibility, categories and variants (SKU, price, promotional price, stock). Use for \"Which Nuvemshop products are nearly out of stock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search text in product names, tags or SKU.","title":"Q"},"max_stock":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only products with stock at or below this number.","title":"Max Stock"},"category_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only products in this category id.","title":"Category Id"},"published":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":null,"description":"true for visible products only, false to include unlisted and hidden ones.","title":"Published"},"sort_by":{"anyOf":[{"enum":["user","price-ascending","price-descending","alpha-ascending","alpha-descending","created-at-ascending","created-at-descending","best-selling"],"type":"string"},{"type":"null"}],"default":null,"description":"Order: user, price-ascending, price-descending, alpha-ascending, alpha-descending, created-at-ascending, created-at-descending or best-selling.","title":"Sort By"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API does not paginate unless asked).","title":"Page"},"per_page":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Results per page (1 to 200, default 30).","title":"Per Page"}},"required":["store_id"],"title":"list_productsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_product":{"post":{"operationId":"get_product","summary":"Get one product by id with names, categories and all variants. Use for \"Show details of Nuvemshop product 1234\".","description":"Get one product by id with names, categories and all variants. Use for \"Show details of Nuvemshop product 1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"product_id":{"description":"Numeric product id.","maxLength":200,"title":"Product Id","type":"string"}},"required":["store_id","product_id"],"title":"get_productArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/find_product_by_sku":{"post":{"operationId":"find_product_by_sku","summary":"Find the product that owns a variant with the given SKU. Use for \"Which Nuvemshop product has SKU BSG1234A\".","description":"Find the product that owns a variant with the given SKU. Use for \"Which Nuvemshop product has SKU BSG1234A\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"sku":{"description":"Variant SKU exactly as stored.","maxLength":100,"title":"Sku","type":"string"}},"required":["store_id","sku"],"title":"find_product_by_skuArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_customers":{"post":{"operationId":"list_customers","summary":"List customers with name, email, phone, total spent, last order id and account status. Identification numbers and addres","description":"List customers with name, email, phone, total spent, last order id and account status. Identification numbers and addresses are not returned. Use for \"Who are my biggest Nuvemshop customers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search text in customer name, email or identification.","title":"Q"},"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Customers matching this exact email.","title":"Email"},"created_at_min":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers created after this ISO 8601 date-time, for example 2026-01-01T00:00:00-03:00.","title":"Created At Min"},"updated_at_min":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers last updated after this ISO 8601 date-time.","title":"Updated At Min"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API does not paginate unless asked).","title":"Page"},"per_page":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Results per page (1 to 200, default 30).","title":"Per Page"}},"required":["store_id"],"title":"list_customersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_categories":{"post":{"operationId":"list_categories","summary":"List product categories with names, parent, visibility and subcategory ids. Use for \"What categories does my Nuvemshop s","description":"List product categories with names, parent, visibility and subcategory ids. Use for \"What categories does my Nuvemshop store have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"parent_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only categories under this parent category id.","title":"Parent Id"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API does not paginate unless asked).","title":"Page"},"per_page":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Results per page (1 to 200, default 30).","title":"Per Page"}},"required":["store_id"],"title":"list_categoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_coupons":{"post":{"operationId":"list_coupons","summary":"List discount coupons with code, type (percentage, absolute, shipping), value, validity window, uses and limits. Use for","description":"List discount coupons with code, type (percentage, absolute, shipping), value, validity window, uses and limits. Use for \"Which Nuvemshop coupons are still valid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"},"valid":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":null,"description":"true for currently valid coupons only, false for invalid ones.","title":"Valid"},"q":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by coupon code text.","title":"Q"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1 (the API does not paginate unless asked).","title":"Page"},"per_page":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Results per page (1 to 200, default 30).","title":"Per Page"}},"required":["store_id"],"title":"list_couponsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_locations":{"post":{"operationId":"list_locations","summary":"List the store's stock locations with names, address, priority and sale-channel tags. Use for \"Where does my Nuvemshop s","description":"List the store's stock locations with names, address, priority and sale-channel tags. Use for \"Where does my Nuvemshop store keep stock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"store_id":{"description":"Numeric id of the Nuvemshop / Tiendanube store (the number after the API version in the store's API URLs).","maxLength":200,"title":"Store Id","type":"string"}},"required":["store_id"],"title":"list_locationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}