{"openapi":"3.1.0","info":{"title":"Nuvemshop Catalog and Checkout Setup (your token) API","version":"0.1.0","description":"Nuvemshop Catalog and Checkout Setup (your token) lets an AI assistant read your own Nuvemshop Config data through the Nuvemshop Config API with a key you supply (store access token). Read-only: 9 tools (list_product_variants, get_product_variant, list_product_images, list_shipping_carriers, get_shipping_carrier, list_shipping_options, list_payment_options, list_payment_providers, list_webhooks)....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-nuvemshop-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-nuvemshop-config/docs"},"termsOfService":"https://connectorbay.com/byok-nuvemshop-config/terms"},"servers":[{"url":"https://byok-nuvemshop-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-nuvemshop-config/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/list_product_variants":{"post":{"operationId":"list_product_variants","summary":"List the variants of one product with SKU, price, promotional price, stock, dimensions, weight, barcode and per-location","description":"List the variants of one product with SKU, price, promotional price, stock, dimensions, weight, barcode and per-location stock levels (needs the read_products scope). Use for \"What variants and stock does Nuvemshop product 1234 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"},"product_id":{"description":"Numeric product id (from the products list of the main Nuvemshop connector or the store admin).","maxLength":200,"title":"Product Id","type":"string"},"since_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only variants with an id greater than this.","title":"Since Id"},"updated_at_min":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only variants 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.","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","product_id"],"title":"list_product_variantsArguments","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_variant":{"post":{"operationId":"get_product_variant","summary":"Get one product variant by id with SKU, prices, stock, dimensions, weight and barcode. Use for \"Show variant 101 of Nuve","description":"Get one product variant by id with SKU, prices, stock, dimensions, weight and barcode. Use for \"Show variant 101 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 (from the products list of the main Nuvemshop connector or the store admin).","maxLength":200,"title":"Product Id","type":"string"},"variant_id":{"description":"Numeric variant id from list_product_variants.","maxLength":200,"title":"Variant Id","type":"string"}},"required":["store_id","product_id","variant_id"],"title":"get_product_variantArguments","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_product_images":{"post":{"operationId":"list_product_images","summary":"List the images of one product with url, position, size and update time. Use for \"Which images does Nuvemshop product 12","description":"List the images of one product with url, position, size and update time. Use for \"Which images does Nuvemshop product 1234 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"},"product_id":{"description":"Numeric product id (from the products list of the main Nuvemshop connector or the store admin).","maxLength":200,"title":"Product Id","type":"string"},"position":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only the image at this position (1 is the main image).","title":"Position"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","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","product_id"],"title":"list_product_imagesArguments","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_shipping_carriers":{"post":{"operationId":"list_shipping_carriers","summary":"List the shipping carriers registered by apps in the store with name, supported types (ship, pickup) and active flag (ca","description":"List the shipping carriers registered by apps in the store with name, supported types (ship, pickup) and active flag (callback URLs are left out). Use for \"Which shipping carriers are set up on my Nuvemshop store\".","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"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","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_shipping_carriersArguments","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_shipping_carrier":{"post":{"operationId":"get_shipping_carrier","summary":"Get one registered shipping carrier by id. Use for \"Show Nuvemshop shipping carrier 1\".","description":"Get one registered shipping carrier by id. Use for \"Show Nuvemshop shipping carrier 1\".","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"},"carrier_id":{"description":"Numeric shipping carrier id from list_shipping_carriers.","maxLength":200,"title":"Carrier Id","type":"string"}},"required":["store_id","carrier_id"],"title":"get_shipping_carrierArguments","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_shipping_options":{"post":{"operationId":"list_shipping_options","summary":"List the shipping options the merchant can offer at checkout, grouped by carrier, with option code and whether free ship","description":"List the shipping options the merchant can offer at checkout, grouped by carrier, with option code and whether free shipping is allowed (needs the read_shipping scope). Use for \"Which shipping options can my Nuvemshop checkout 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":"list_shipping_optionsArguments","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_payment_options":{"post":{"operationId":"list_payment_options","summary":"List the checkout payment options of the payment providers the merchant activated, with supported method types and integ","description":"List the checkout payment options of the payment providers the merchant activated, with supported method types and integration type (needs the read_payments scope). Use for \"Which payment methods does my Nuvemshop checkout offer\".","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_payment_optionsArguments","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_payment_providers":{"post":{"operationId":"list_payment_providers","summary":"List the payment providers installed by apps in the store with name, supported currencies, enabled flag and support site","description":"List the payment providers installed by apps in the store with name, supported currencies, enabled flag and support site. Use for \"Which payment provider apps are installed on my Nuvemshop store\".","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_payment_providersArguments","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_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks the access token's app registered in the store, with event name, target url and dates; filter by event","description":"List the webhooks the access token's app registered in the store, with event name, target url and dates; filter by event or url. Use for \"Which Nuvemshop webhooks does my app 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"},"event":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only webhooks for this event, for example 'order/created'.","title":"Event"},"url":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Only webhooks pointing at this url.","title":"Url"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","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_webhooksArguments","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}}}}