Working with eCom (E-Series) API platform requires advanced programming skills. If you need developer assistance, check out the eCom (E-Series) custom development team.
The eCom (E-Series) API platform allows you to add various extra features to your store, like:
- Advanced sales reports.
- Integrations with third party services like shipping companies or payment gateways.
- Notifications about store events (using webhooks).
- Online store inventory synced with your offline catalog.
- Swift data migration when migrating a store from another platform.
- Tailored storefront design updates and more.
Adding features using the eCom (E-Series) API
To allow the code to connect to your store via the eCom (E-Series) API, you’ll need a special customization app. Each feature or tool you want to add requires an individual app.
To add features to your store via the eCom (E-Series) API:
- Access the hidden Manage your apps page. When you open the page, your first app will be automatically created and installed.
You can start making requests to the eCom (E-Series) REST API.
- Click Details to access the app page, where you'll find your public and secret access tokens as well as the app keys (Client ID and Client secret).
- Click Check docs and use the eCom API documentation to develop features.
- Click Details to access the app page. In the Update app section, click Contact to let our API team know what features you want to use so we can update data in the App details section (app settings are in read-only mode).
- (Optional) To create more apps, click Create in the Add new app section of the Manage your apps page.
The feature-specific app is now ready to use. You can access it from the hidden Manage your apps page.
Disconnecting apps
To disconnect an app and remove it from your store:
- In your eCom (E-Series) Admin Panel, navigate to Apps > My Apps.
- Find your custom app and click Details.
- In the Permissions section, click Uninstall > Uninstall app.
Reinstalling apps
If you want to reinstall the app later, navigate back to the Manage your apps page, click Details next to your app, then click Install.
If you reinstall the app, your public and secret access tokens will change.
Contacting the API team
If you have any questions during development or need to update the app settings (scopes, URLs, etc), contact our API team:
- Navigate to the Manage your apps page.
- Click Details next to your app.
- Scroll down to the Update app section and click Contact.
What's next?
Custom development services for eCom (E-Series)
Request custom enhancements to your online store.
Learn more