Nuvemshop API: what you can do and how to use it with AI agents
The Nuvemshop API lets you read and update a store's products, variants, stock, orders, customers and coupons, and receive events by webhook. Merchants, agencies and developers of apps for the platform use it. Access happens through an app authorized by the store owner.
What the Nuvemshop API offers
Products and variants
Create products and edit price, description, images and variants.
Stock
Update available quantities per variant.
Orders
Query and update orders, payment and shipping status.
Customers
Read the data of customers registered in the store.
Coupons
Create and manage discount coupons.
Webhooks
Alerts for a new order, payment, product change and other events.
How to access the Nuvemshop API
- With your company’s credentialsUses OAuth 2.0: the app is created in Nuvemshop's partner portal and the merchant authorizes it, which generates the access token for that store.
- There is a request limit per store: avoid frequent full scans.
- Ask only for the scopes the process uses.
- Customer data falls under Brazil's LGPD (the data-protection law).
Official documentation: tiendanube.github.io/api-documentation
What an iTeam agent does with the Nuvemshop API
Order status on WhatsApp
The support agent looks up the order by number and replies to the customer with payment, shipping and tracking.
Product descriptions revised
The agent rewrites weak descriptions from the spec sheet and uploads them to the store after the owner approves.
Low-stock alert
When a best-selling variant hits its minimum, the agent alerts purchasing with the turnover history.
Coupon for a repeat customer
The agent creates a single-use coupon for a customer who complained about a delay, within the approved discount limit.
From the credential to the agent at work, with approval
Create the app in the partner portal
Create an app in Nuvemshop with the scopes you need (products, orders, customers) and install it in the company's store.
Store the token in the vault
The token generated at installation stays in the iTeam vault, and each agent gets only the actions it needs.
Test with approval
Keep price, product and coupon changes under approval for the first weeks.
Ready-made AI teams that use Nuvemshop
Questions about the Nuvemshop API
Is the Nuvemshop API free?
Generally yes: the API is part of the platform and has no separate charge. There may be a cost for third-party apps or for the store plan.
Do I need to write code to use the Nuvemshop API with iTeam?
Not necessarily. The iTeam deployment team creates the app and sets up the actions from the documentation, and you only approve what the agent does.
Does the Nuvemshop API work for Tiendanube?
Yes. Nuvemshop and Tiendanube are the same platform and share the same API.
