← Go back to Intro

The Ecwid API Platform

Ecwid’s API is a RESTful API with oAuth2 authentication. Any developer can use it to manage store data, add new interfaces to the Ecwid Control Panel, and even customize the storefront from an external application.

The API specs and documentation provide examples and even a playground tool to explore the API’s capabilities, which is available here: http://developers.ecwid.com/api-documentation. Below, we highlight some of what feel are the coolest and most powerful features of the Ecwid API.

oAuth2

order_editor_auth

The application authorization is based on oAuth2, allowing your application installation flow to be smooth and seamless for the end user. A merchant just needs to allow your application to access their data and they are done.

The process works similar to the well-known “Login with Google” or “Login with Facebook” tools; no more copying and pasting API keys. Another great advantage of oAuth2 is the amount of control you can have over a store’s data; the ability to manage the specific data an application needs and access permissions on a granular level are inherent with the Ecwid API, giving you and merchants unprecedented control over customizing the online store.

This also lets you be transparent about what merchant data you’re using and how you are using it, thereby increasing confidence in your application and building trust in the relationship with Ecwid merchants right from the start.

REST

update_combo_2

The well-known uniform REST interface in the Ecwid API enables you to easily read, update, create and delete store data from outside of Ecwid, including:

  • Store profile
  • Store categories
  • Products (as well as their variations, attributes, files, images gallery and inventory)
  • Orders and customers
  • Discount coupons
  • and others

Native Applications

edit-orders-cp

Using the Ecwid API, you can add your application right into the user Control Panel. Your application will work just like a native feature of Ecwid.

Being integrated with Ecwid this way, your app will get more visibility and engagement with Ecwid merchants — it will be a part of a merchant’s Control Panel and smoothly integrate itself into the back-end management process.

To learn more about this capability, please visit http://developers.ecwid.com/api-documentation#embedded-apps in the API documentation

Customize Storefront

Depending on the kind of application you integrate with Ecwid, you may want to customize the user storefront in some way. For example, you could:

  • Apply custom styles to the store elements (buttons, fonts, pictures etc.)
  • Add extra widgets (customer reviews, comments, image magnifier, etc.)
  • Modify the look and feel of the online store
  • Add tracking pixels or any other third party conversion-tracking scripts at the checkout page

Your application can do all of that automatically. Just provide us with a URL of your JavaScript or CSS files, and Ecwid will do the rest. Your JavaScript or CSS is loaded automatically into a merchant’s storefront, be it on their site, Facebook page or Ecwid Starter Site.

Webhooks

Using webhooks, you can receive instant notifications about changes in an Ecwid store. After you set them up for your app, you will be able to react instantly to the events you subscribed to.

For example, do you want to send order details to a fulfillment system right after an order was placed? Or maybe you need to check up on a customer with an unfinished order? Webhooks is an easy, effective solution to these questions and many more. Learn more about using webhooks with Ecwid

Custom Payments, Shipping and Discounts

With Ecwid API Platform you can integrate any payment, shipping or discount provider. Alternatively, you can create your own custom rules and workflows, like free shipping for local customers based on current date, customer group other info from customer’s cart.

The process is simple: Ecwid sends order information to your discount/shipping provider and expects it to return optional rates for the information provided. Custom payments work as any other payment — when customer selects that method at checkout, Ecwid will send all available order data there, to expect order status to be updated and customer returned back to the storefront.

All these features are natively added to the Ecwid storefront, so it works seamlessly together with existing functionality.

Order Extra Fields

Running an online store nowadays requires many things to be tracked and stored. For example: “Did the customer come from an ad campaign? Or were they referred by our affiliate partner?”. To know and store things like this, use the Order Extra Fields feature.

With Order Extra Fields you are able to save custom data to order and then later get it in order details via Ecwid REST API. It’s not just the private information too — you can add new optional or required fields right in the checkout process too. This information can be made visible in the order details to merchant and customer.

Get to know Apps and App Market →