FAQ

Do I need an app to work with the API?

Yes. Applications are a way for your code to connect to the store via the API Platform. Apps can be published for everyone through the App Market or used to customize a single store. If you register an app, it will not become visible to other Ecwid users automatically.

Can I get a sandbox store for testing?

Yes, you can start working on your application in a test store. Firstly, make sure you have a test account registered at https://ecom.lightspeed.app/cp/#register . Once you have it, please fill out the app registration form: https://portal.ecwid.com/en-us/app-market-request

Can I develop the app in a local environment?

While your app is not added to any real store, you can use your dev environment to develop and test the app before release. To continuously improve your public app we recommend you register a dev version of the app.

How do I update my application settings?

To change your application settings (e.g. scopes, URLs, etc), please contact us at [email protected] email.

My app is ready. What do I do next?

Great! There are a few simple steps to get your app approved and published. Please fill out the form about your app.

How do I get paid?

There are two billing options available: Ecwid billing and your own custom billing scheme. So the payouts depend on the billing options you choose for your app. More details you can find on the following page: https://api-docs.ecwid.com/reference/billing

How should I handle free Ecwid users?

Ecwid has over 1 million users, and many of these users are on our free plan, which does not provide them access to the API and, therefore, any apps built with it.

We will make sure they are aware of the plan they need when they are scouring apps and will showcase the benefits of being able to utilize these best-in-class apps and technologies. For your prospects, it is important to be transparent regarding the need for a paid plan and to clearly define the benefits and ROI of your service to justify the cost.

Is there a limit on the number of API calls my application can make?

We constantly monitor API activity and servers load on our side to make sure every application uses API properly. Applications abusing REST API will get blocked automatically. Learn more on how to avoid getting blocked: API calls limits.

How should I provide support?

If our joint customer is having difficulties installing or using an app, they can contact our Support or use Live Chat in their Control Panel and we will be happy to assist. However, please do have your support team ready for any possible issues specific to your application functionality, billing or user interface.
More details about providing support to users

Will Ecwid help me with marketing my app?

Due to the fact that there are multiple apps in the App Market, and we want to treat everyone as equally as possible, we cannot commit to any specific marketing programs on an individual app basis. However, we’ll be announcing all new apps via social media and the blog posts about new apps in the Ecwid Blog.

Additionally, we welcome our developers to create unique, thought leadership posts for our blog, which we will be happy to post on your behalf and make sure the final call-to-action is to download your app. These blogs should not be an advertisement, but something helpful for someone running an online business. For example, if you have an app that helps improve the user experience on mobile devices, you’d want to write a blog like this one. Let us know an idea you had for a blog, and we’ll work with you and your team to get this published on the Ecwid blog.

How to check if a customer agreed to receive promotional emails?

Store customers can be asked to receive email marketing at checkout with a native checkbox field. Get their response in order or customer details. If it is “true” or not present, you can use customer email for marketing purposes. If it is “false” — you can't use details of that customer for email promotions.
In REST API
Check the value of “acceptMarketing” field in /orders or /customers endpoints.
In Ecwid Control Panel
— For order details → “Additional information” block.
— For customers list → check the “Email marketing” column.
Merchants can customize this checkbox in: Ecwid Control Panel → Settings → General → Cart & Checkout → Newsletters. These settings are also available in the Ecwid REST API.