Overview
What marketapi does, the phases of an integration and what each part of the API covers.
marketapi is an API for selling on several marketplaces at once: Mercado Livre, Magalu, Amazon, TikTok Shop and Shopee. You integrate once. Each of your sellers connects their accounts, and your system lists, sells and serves buyers through a single API.
Who is who
| Who | What it is |
|---|---|
| You (account) | The company that integrates. Has the dashboard login and the API keys. |
| Seller | Your customer: the one who sells. Has no login here. Connects their marketplace accounts on a page we host. |
| Connection | One marketplace account of the seller, such as their Mercado Livre store. |
The phases
| Phase | What you do | API parts |
|---|---|---|
| 1. Set up | Create the account, the API key and the endpoint that gets webhooks. | Authentication · Webhooks |
| 2. Connect | Create the seller and send them the link to connect a marketplace. | Sellers · Link sessions · Connections |
| 3. Catalog | Register products, variants, kits, photos, warehouses and stock. | Products · Assets and media · Warehouses · Inventory |
| 4. Publish | Build each marketplace's listing and publish it. Or import the ones that already exist. | Marketplace products · Listings |
| 5. Stay in sync | Keep stock, price and status the same on both sides. | Listings · Inventory · Fulfillment inbound shipments |
| 6. Sell | Get the order, send the NF-e, ship it and handle returns. | Orders · Invoices · Shipments · Returns · Disputes |
| 7. Serve | Answer questions, messages and reviews. | Questions · Conversations · Reviews |
| 8. Grow | Run promotions, tune prices, follow Ads, metrics and payouts. | Promotions · Pricing and fees · Ads · Metrics · Finance |
Four rules that apply everywhere
- Whatever talks to the marketplace runs in the background. The API answers right away with a job, and the work goes on after.
- Every change becomes a webhook. You find out without polling. See Receiving webhooks.
- The catalog belongs to the seller. The marketplace never changes a product, variant or stock. What changes out there is kept on the listing, apart.
- Each marketplace does different things. Before an action, the Connection tells you whether it can. See Capabilities.
An example: one sale
Acme Store has 100 units of the black iPhone 16 and lists it on Mercado Livre, Amazon and Shopee. A sale comes in on Mercado Livre:
- marketapi gets the order and tells you with the
order.createdwebhook. - The order is paid, and 1 unit is reserved. 99 remain available.
- marketapi sends 99 to every listing of that iPhone, on its own.
- You send the NF-e, print the label and ship. The reservation becomes a sale.
The full path, step by step: The order lifecycle.
Where to go next
Getting started
From the API key to the first seller, in five commands.
How it works
Each phase in detail: what happens, what to call and which webhooks arrive.
Data model
Every resource and how they link, with diagrams.
API reference
One page per endpoint, with fields, examples and a playground.
The API lives at your environment's address, under /v1.
Integrating with an AI assistant?
The whole documentation is in plain text, in one file, at
/llms-full.txt. The index is at /llms.txt.