How to create an OAuth app in Lightspeed eCom (E-Series, Ecwid)

This guide walks you through registering an Ecwid app and adding its OAuth credentials to Apideck, so your users can connect their Lightspeed eCom (E-Series) stores through Vault.

The Lightspeed eCom (E-Series) connector uses the Ecwid REST API. Ecwid issues OAuth credentials to registered apps only, so you start by registering an app with Ecwid. Once your app is registered, your users connect by entering their Store ID and approving your app on a single Ecwid screen.

Before you start

• You register the app through Ecwid's app request form. Ecwid describes the full route in Steps to go live with a public app.
• Your app needs to be an External app, meaning it runs the OAuth flow outside the Ecwid control panel. Ecwid explains the app types in Native and external apps.

To set up the connector, complete these steps:

1. Request your Ecwid app
2. Find your Client ID and Client Secret
3. Add your credentials to Apideck
4. Make your app available to your users' stores

1. Request your Ecwid app

Include the redirect URL and the access scopes in your request. Ecwid's documentation notes that the redirect URL is set at registration and that changing it later means contacting Ecwid.

1. Open the Ecwid app request form.

2. Describe your app idea, the billing type and the regions you plan to serve.

3. Include this redirect URL in your request:

   https://unify.apideck.com/vault/callback
   

4. List these access scopes in your request. The connector requests all of them during authorisation:

   • read_store_profile
   • update_store_profile
   • read_catalog
   • update_catalog
   • create_catalog
   • read_orders
   • update_orders
   • create_orders
   • read_customers
   • update_customers
   • create_customers
   • read_discount_coupons
   • update_discount_coupons
   • create_discount_coupons
   • customize_storefront
   • add_to_cp
   • add_shipping_method
   • add_payment_method
   • public_storefront
   • customize_cart_calculation
   • read_invoices
   • charge

   Ecwid documents what each scope allows in its app settings reference.

5. Submit the form.

Once Ecwid approves your request, you receive a development app and a free test store on a Premium plan. Use this test store to try the connection.

2. Find your Client ID and Client Secret

1. Log in to your Ecwid test store admin and open Develop apps at https://my.ecwid.com/#develop-apps.
2. Open your app's Details page.
3. Scroll to the bottom of the page to find the client_id and client_secret.

Ecwid also emails you the client secret when it registers your app. Keep it somewhere safe and treat it like a password.

3. Add your credentials to Apideck

1. Open the Apideck Lightspeed connector settings in the Apideck Dashboard.
2. Select Use your own client credentials.
3. Paste your Ecwid client_id into Client ID and your client_secret into Client Secret.
4. Save your settings.

Your users can now connect in Vault. They enter their Ecwid Store ID (a number) and then authorise your app on the Ecwid screen. Apideck stores the resulting access token for each connection.

4. Make your app available to your users' stores

To let merchants beyond your own test store connect, Ecwid offers two routes:

• Contact Ecwid API Support to have your app enabled for installation in the stores you work with.
• List your app in the Ecwid App Market. Listing is free, under an Ecwid partner contract with revenue sharing, and Ecwid validates the app before it goes live. Ecwid describes the checks in its guide to app validation.

FAQ and troubleshooting

Do access tokens need to be refreshed?

No. Ecwid access tokens do not expire and Ecwid issues no refresh token. A connection stays valid until the merchant uninstalls your app from their store.

A user sees a redirect URL error when authorising

The redirect URL registered with Ecwid must be exactly https://unify.apideck.com/vault/callback. If Ecwid registered a different value, contact Ecwid to update it.

A user sees a scope or permission error when authorising

Check that your app's access scopes in Ecwid cover every scope listed in step 1.

A user connects but API requests fail

Only Ecwid stores on a paid plan can access the API. Ask the user to confirm their store's plan in their Ecwid admin. Also check that they entered the correct Store ID, which appears at the bottom left of every Ecwid admin page and in the admin URL, for example https://my.ecwid.com/store/38396052#dashboard.

Where can I learn more about the Ecwid API?

See the Ecwid API documentation. For help with the Apideck side of the connection, contact Apideck Support.