Postman Collection 4 weclapp

Before you build an integration with weclapp, you want to know what the API actually returns. With the free Postman Collection 4 weclapp you send the requests you need against your test system before the first line of code is written. That way you see early which fields come back, which filters take effect and where your plan still has gaps.

What's inside

The collection covers the complete official weclapp API v2: 1,109 requests, from articles and customers to sales orders, shipments and invoices, all the way to warehouse, time tracking and contracts. On top of that come 525 unofficial requests for endpoints that are missing from the public docs. You recognise them by the tag “[inoffiziell]” in their name. Only try them against a test system.

In total that is 1,634 requests in 212 folders, sorted by area. All requests share one base URL, so you set your tenant only once.

How to get started

1. Order the collection for free and download the JSON file.
2. Load the file into Postman via “Import”.
3. In the collection variables, replace dein-mandant.weclapp.com under host with your tenant and enter your API token under apiKey. You find the token in weclapp under “My settings” in the API section.
4. Send your first request, ideally against a test system rather than your production data.

Read on in the API handbook

What to watch out for while testing is covered in our series “weclapp API: The Handbook”. You can rebuild many of the requests from the articles directly with the collection.

• The silent errors of the weclapp API
• Dates, numbers, custom attributes: the data type traps of the weclapp API
• More API than the docs show: using unofficial weclapp endpoints safely

Before you send in bulk

The weclapp API has no fixed per-minute limit, but it does limit parallel requests per tenant. What that means for your integration is explained in Does the weclapp API have a rate limit?

Rather not build everything yourself?

We build weclapp integrations for our customers and know the spots where the API gets stuck. In a short intro call we look at your project together.