Getting Started with Ecart API
Welcome to Ecart API
Ecart API is a unified API that lets you work with multiple ecommerce platforms and marketplaces through one integration. You build one integration and your customers connect their stores (Shopify, Wix, Mercado Libre, and more) via Ecart API's authentication flow.
High-level flow
| Step | What you do |
|---|---|
| 1 | Create an app in your account and set a Redirect URL. |
| 2 | Let your customers connect their stores using Ecart API's OAuth flow; they are redirected to your URL with an access token and store data. |
| 3 | Validate the integration (e.g. with the ecartapi_key HMAC) and store the access token linked to your customer. |
| 4 | Call Ecart API using the store access token as Bearer in the Authorization header. Choose v1 (raw), v2 (unified, recommended), or v3 (centralized) depending on your needs. |
| 5 | Optional: Customize the integration page (app name, logo, custom domain) for a white-label experience. |
Summary: One integration → many ecommerces. All requests use a Bearer store access token. Create an app, connect stores via OAuth, validate and save the token, then call the API.
What EcartAPI is — and is not
EcartAPI is a merchant-side B2B integration API. It connects your application to the seller's side of ecommerce platforms: managing orders, products, inventory, fulfillments, and customers on behalf of store owners.
EcartAPI is not:
- A consumer-facing shopping or cart API — it does not add products to buyers' carts or interact with consumer checkout flows.
- A grocery, delivery, or last-mile logistics API — it does not integrate with grocery retailers or consumer delivery services.
- A B2C storefront API — it works with merchants and their stores, not with end shoppers.
If your use case involves automating something a store owner or operations team does (manage orders, sync inventory, post fulfillments, retrieve products), EcartAPI is the right tool. If your use case involves something a consumer does (browse, add to cart, checkout), EcartAPI does not cover it.
Next steps
Follow these guides in order:
| Guide | What you'll learn |
|---|---|
| Create your app | My Apps, New App, app name, Redirect URL |
| Store authentication | Integrating a store, validating integrations, redirect URL parameters |
| OAuth 2.0 | OAuth URL, customer steps, what you receive in the redirect |
| Store access token | Where to find it, saving it, using it as Bearer |
| API endpoints | API versions (v1, v2, v3), base URL, example paths |
| Set up the integrations page | App name and logo, custom domain (CNAME), parameters and test URL |
| Identifying stores and customers | state parameter, shop_id, userId reliability, multi-marketplace stores |
| Testing without a sandbox | Free tier, webhook testing, shared credentials for development |
| Billing and request counting | What counts as a request, pagination, webhook billing, usage estimation |
| Use case: Shipping and carrier platforms | End-to-end flow for 3PL and carrier integrations |
For detailed endpoint reference per platform, see the API Reference section.
Updated about 9 hours ago