Yampi API: what you can do and how to use it with AI agents
The Yampi API gives access to the orders, products, customers, coupons and carts of a store or checkout. E-commerce merchants and integrators use it to connect Yampi to an ERP, logistics and customer service. Access is through a token and a secret key generated in the store dashboard. Yampi is a Brazilian platform, so this guide suits companies that sell in Brazil.
What the Yampi API offers
Orders
Reading and updating status, payment and delivery.
Products and stock
Catalog, variants, prices and quantities.
Customers
Customer records and purchase history.
Abandoned carts
Unfinished carts, with items and contact details.
Coupons
Creating discounts and setting their rules.
Webhooks
Notices when an order is created, paid, canceled and for other events.
How to access the Yampi API
- With your company’s credentialsA user token and a secret key generated in the Yampi dashboard, sent in the header, together with the store alias in the URL.
- Respect opt-in for abandoned-cart messages, as Brazil's LGPD data-protection law requires.
- There are request limits, so use webhooks for events.
- Set a cap on discounts created by agents.
Official documentation: docs.yampi.com.br
What an iTeam agent does with the Yampi API
Abandoned cart with a conversation
The agent picks up unfinished carts and chats on WhatsApp, answering questions about shipping and delivery time before sending the link.
Unpaid Pix
Orders with a Pix payment (Brazil's instant payment method) generated but not paid get a reminder from the agent with the code before it expires.
Paid order not shipped
The agent flags paid orders that did not go to picking within the deadline.
Win-back coupon
For customers with no recent purchase, the agent creates a personal coupon and tracks its use.
From the credential to the agent at work, with approval
Generate the token and key in Yampi
In the dashboard, create the API credentials for a dedicated user.
Store them in the iTeam vault
The credentials stay in the vault. Support reads orders, and marketing creates coupons within limits.
Test with approval
Cancellations, refunds and coupons above the cap go through human approval.
Ready-made AI teams for this work
WhatsApp customer service
Customers write at 11 p.m. and on Sundays. This team replies in seconds, with your prices and policies, and calls a person when it should.
Help desk support team
It reads each ticket, finds the answer in your docs and past replies, and drafts a response your agents can send or improve.
AI phone receptionist
It answers the phone, books the visit in your calendar and sends your team a short note about every call.
Online store support team
It looks up the real order in Shopify or WooCommerce and answers tracking, return and exchange questions in seconds.
Customer success team
It reads usage, tickets and CRM notes every week and tells your team which accounts need a call, and why.
Customer feedback analysis
It reads every comment, finds the themes behind the scores and tells each area what customers are asking it to fix.
Questions about the Yampi API
Is the Yampi API free?
In general the API is available to Yampi stores depending on the plan. Confirm in your dashboard.
Do I need to code to use the Yampi API with iTeam?
Not necessarily. iTeam's HTTP tool reads the documentation, and the deployment team sets up the workflows.
Can I recover abandoned carts through the API?
Yes. The API exposes the carts, and the agent can run the recovery on the channel you agree on.
