What we do
Tools
Industries
Department
How we workLet's talk →
Home/Ecwid/An Ecwid API Integration That Hears Every Order
Ecwid REST API

Ecwid API Integration: Getting Each Order Out of Ecwid and Into the Systems It Skips

You want every Ecwid order to land somewhere Ecwid doesn't reach: a warehouse sheet, a CRM, an in-house ERP. Before writing code, look in the App Market. Its Accounting category already has apps such as Synder, which syncs Ecwid sales into QuickBooks, Xero, NetSuite or Sage Intacct. When no app fits, the Ecwid REST API and its webhooks are the route, and they're open only to stores on a paid plan.

Setting up Ecwid API access and webhooks in five steps

  1. 1

    Open the app dashboard

    Sign in to the store and go to my.ecwid.com/#develop-apps. The first time you open it, Ecwid creates a custom app for you. Only paid plans get API access, though Ecwid support can upgrade a test store for free in some cases, integration testing among them.

  2. 2

    Copy the secret token, and keep it off the storefront

    The secret token can do whatever the app's scopes allow, so it lives on your server only. The public token is for storefront code: it sees enabled products and categories, a little store profile data, and can place orders that aren't marked paid. Neither expires.

    Watch for: tokens belong to one store. Even for the same app, a token from one store won't work on another.

  3. 3

    Add the scopes you need

    A new custom app can read and change products, categories and orders, and read the store profile. Customer data isn't in that set, so read_customers has to be added. After any scope change, reinstall the app so it takes effect.

  4. 4

    Make a first call

    Requests go to https://app.ecwid.com/api/v3/{storeId}/ with the secret token as a Bearer token in the Authorization header. A GET on /orders is a quick way to prove the token and scopes work.

  5. 5

    Ask Ecwid to switch on webhooks

    The app needs two more settings: the list of events and a static HTTPS webhookUrl that accepts POST requests. You send both to Ecwid's API support team as an application update request. Pick only the events you need, such as order.created and product.updated.

Ecwid webhook habits that bite a new integration

Treating the webhook as the whole order

How you'll know: Your handler has an ID and a payment status, and nothing else.

Fix: Ecwid keeps webhooks small: an entityId and, for some events, a data object. Order webhooks carry payment and fulfillment status. Fetch the full record through the REST API as soon as the webhook lands, and for orders use orderId rather than the internal entity ID.

Replying slowly, or with the wrong 2xx

How you'll know: The same order.created keeps arriving, and the other system ends up with duplicates.

Fix: Ecwid gives you 3 seconds to accept the connection and 10 to reply. Only 200, 201, 202, 204 or 209 counts as delivered. Anything else, including 203 and 208, means Ecwid tries again over the next 24 hours. Reply first, process from a queue, and skip event IDs you've already handled.

Skipping the signature check

How you'll know: Your endpoint accepts any POST that looks roughly like Ecwid's.

Fix: Each webhook carries an X-Ecwid-Webhook-Signature header: a base64 HMAC-SHA256 of the event's creation time and event ID, signed with the app's client secret. Drop any request whose signature doesn't match.

An endpoint nobody notices is down

How you'll know: A server move or an expired certificate, and orders stop flowing for days.

Fix: If the webhookUrl fails to respond for two weeks, Ecwid blocks webhooks for the app. Log each delivery so a silent gap shows up long before that.

Changes that echo back and forth

How you'll know: A stock change bounces between Ecwid and the warehouse sheet without end.

Fix: Webhooks fire for changes made through your own REST calls too. Mark the writes your integration makes, and ignore the webhook each one causes.

Before you write Ecwid API code: is there an app for it?

What you want connected Try first When it takes the API
QuickBooks, Xero, NetSuite or Sage Intacct The App Market's Accounting category. Synder posts each order with taxes, discounts, shipping and fees, or one summary entry per period or payout. Your accountant wants orders split by channel, or a ledger none of the apps support.
An existing WordPress, Wix or Squarespace site Ecwid's WordPress plugin, or its embed code on other site builders. You're building a custom storefront, which can read the catalog with the public token.
Amazon, eBay or another marketplace Apps in the Selling on Marketplaces category, on the Business plan and up. Stock is mastered in a system other than Ecwid, so listings need numbers Ecwid doesn't hold.
A payment processor Ecwid doesn't list Ecwid's payment settings, to confirm it really isn't offered there. It's missing. Then it's a payment app: Ecwid sends the shopper and the order data to the app's paymentUrl, and the app handles the processor.
A CRM, warehouse system or in-house ERP The Catalog & Order Management and Tools categories in the App Market. No app exists, or the one that does drops fields you rely on. That's the REST API and webhooks.

Ecwid integrations: platforms, channels, payments and the API

Does Ecwid integrate with WordPress?

Yes. Ecwid's WordPress plugin embeds the store in a WordPress site, so the same catalog and checkout work there and everywhere else Ecwid sells. Wix and Squarespace sites can embed it as well.

Can Ecwid sell on Amazon or eBay?

Yes, through apps in the App Market's Selling on Marketplaces category, available from the Business plan up. Listings run from your Ecwid catalog. Those apps can charge their own fees, so compare them before choosing one.

Does Ecwid have an API?

Yes. The REST API covers products, categories, orders, customers and more, webhooks report changes as they happen, and a payment API lets an app take payments for a provider Ecwid doesn't list. Access comes through a custom app and needs a paid plan.

Can I use a custom payment gateway with Ecwid?

Yes, as a payment app. At the last checkout step the shopper goes to the app's paymentUrl along with the order data, and the app deals with the processor and sends the shopper back. It's a documented route in Ecwid's own developer docs.

Is Ecwid the same as Lightspeed now?

Lightspeed bought Ecwid in 2021, and the product is now sold as Ecwid by Lightspeed. It keeps its own admin, API and App Market, and Lightspeed Retail POS can sync products, customers, inventory and orders with it.

Does Ecwid connect to QuickBooks?

Yes, through apps rather than a built-in setting. Synder, in the App Market's Accounting category, syncs Ecwid sales into QuickBooks, Xero, NetSuite or Sage Intacct, order by order or as summary entries. A custom sync only makes sense when those apps can't post orders the way your accountant needs.

Who can build an Ecwid API integration for us?

n-frames writes them for Ecwid stores: the custom app and its scopes, a webhook handler that replies inside Ecwid's time limits and checks signatures, and the sync that sends orders, customers or stock to your CRM, warehouse system or ERP.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.