API Documentation

API Version 1.1 preview

We have fixed some issues related to the handling of XML requests and responses. As this would be a breaking change for most of our users, we're introducing this change as a new version of the API.

We have 4 new XML Schema files (XSD):

To use these files instead of the previously used ones, you have to add a query parameter v=1.1 to the request URL. The request body will then be validated against the new XSD files and the respond body will also correspond to them.

As you can see, we don't use two different XSD files for collections of resources (Products/Orders) and a single resource (Product/Order).

We also made sure that with the new XML Schema you only need to set the attributes that you want to update and don't have to provide any attributes you want to leave unchanged. So for example, the following XML is a valid request body to change the availability of your product:

<?xml version="1.0" encoding="UTF-8"?>
<product xmlns="http://dawanda.com/api/resources/schemas/v1.1/Product">

Responses that didn't use a XML Schema before, will correspond to the Response.xsd file. This should make the response handling easier for users who rely heavilly on the XML Schema.

Besides the new XML handling, the rest of the API behaves exactly as with the previous (1.0) version, so if you want to start using the new version, you only have to update the (de-)serialization logic of your application.

The 1.1 version of the API is already live, but it might still receive a few changes as we receive feedback from our users. We expect it to be finalized in the next few weeks. The documentation will be updated then accordingly.