API update in 2 weeks

7 May 2025, 10:00

Two weeks from now, during the weekend of May 24th, we will implement the new EasyWebshop API. For our less technical audience: the API bridges your webshop to external platforms like payment providers, delivery services and office applications. It also allows you to create custom reports, accept or deny customers in real-time and synchronize sales and inventory with local applications.

Image of developers

Thanks to compatibility with general practices and industry standards, it will be much easier to create new API connections, possibly with the help of AI generated code. This takes away a mayor financial barrier for small businesses who want to build custom connections themselves.

Hiring an experienced web developer will still be possible during the Summer of web design which we will be organizing for the 3rd time, starting on June 21, 2025.

Changes to the API

If you are currently using the API, you will have to - slightly - update your connection. If you are not using the API, you can skip this boring technical part.

API Permissions

Authentication with tokens: When the new API is implemented, it is recommended to create a token at API settings, set the permissions and change the Authorization header method from "Basic" to "Bearer YOUR_API_TOKEN". The Basic authentication with administrator accounts will continue to be functional but will be phased out by the end of this year. Authentication with the email address and password of the main account will no longer be possible.
Default to JSON: When the current API was launched in 2012, the XML format was chosen as the default. The new API will use JSON as default, but you can still switch to XML by adding the "?format=xml" query string to the URL.
Compatibility with standard JSON-LD schemas: Products will follow schema.org/Product whenever possible. The most important change is that the "product_code" changes to "productID". Orders will follow schema.org/Order. The most important change here is that "order_code" changes to "orderNumber".
Simplified API entry points: The entry points like "productlist" will no longer work. The four valid entry points are: "category", "product", "customer" and "order".
Uploading product photos: There will be no separate method for uploading photos anymore. We simplified this and made it possible to attach photos when inserting and updating products.
Category names and product names and descriptions: It will be possible to insert and update category names and product names and descriptions in all languages, even if the language is not activated in the webshop.
Structure in API Push will be slightly different: API Push is used for sending Customer and Order information in real-time. The structure will have better compatibility with schema.org/Person and schema.org/Order.
Creating API connections better documented: Connecting payment providers, delivery services and office applications will be a lot easier. The new documentation will provide extensive examples for setting up such connections quickly.

The new API will be fully documented on the API documentation page in all 20 languages. Our support service will be available during the weekend of implementation to quickly help you to make changes to your existing implementation.

News

FAQ Contact