Ecwid REST API grants access to the store data including products, orders, customers, discounts, and many more. Everything you can do from Ecwid admin is also available through REST API: manage customers, create new products, update order statuses, etc.
Sign up with Ecwid
To start working with Ecwid API, you need a store on any paid plan. Sign up with Ecwid.
We will upgrade your test store for free granting it API access if you:
- Work on a customization for one of our clients
- Want to develop a customization for your working store in a safe environment
- Develop a public application for our App Market
Email us to get a test store upgrade.
Set up an application
API access requires a platform where you can configure permissions and generate tokens. In Ecwid we refer to this platform as an application. A private application that gives you access to your store data through API is referred to as a custom application.
Set up a custom application in your Ecwid Control Panel, it only takes a few seconds: #develop-apps
Start making requests
Any REST API request needs at least store ID and token for authorization.
You already have the app with access tokens. Copy your access token, then scroll Control Panel page to the bottom and find your store ID in the footer.
To make a simple "Get orders" request, add store ID to the request URL path and a token to the header, then execute it.
Request example:
curl --location 'https://app.ecwid.com/api/v3/STOREID/orders' \
--header 'Authorization: Bearer SECRET_TOKEN'
You'll receive a response with JSON object in the body:
{
"total": 1,
"items": [
{
"id": "EBJFT",
"total": 600,
"email": "[email protected]",
"discount": 0,
"items": [ ... ]
}
]
}
By default, custom apps have limited access to REST API. You can add more permissions to the app configuration. Learn about custom app configuration.
Features availability
Ecwid API is available on any paid plan. With API you can access all features active on the current store plan. See: Plans and features
Rate limits
You can make up to 600 requests per minute with one application token which becomes temporarily blocked if you exceed the limit. API responds with error 429 to all requests at that time.
In case a token is no longer valid, the limits are:
- 20 requests per minute per token
- 600 requests per IP
Ecwid will permanently block the token and IP pair if you exceed them.