WinShop Web API
Developer documentation for integrating e-shops, accounting, BI and in-house systems with WinShop.
WinShop is a retail and wholesale system: products, prices, stock, customers and the business documents that move goods and money (orders, delivery notes, invoices and so on). The WinShop Web API is its HTTP interface. It speaks JSON over HTTPS and uses OAuth 2.0 client credentials.
This site is for developers who connect another system to WinShop: an e-shop, an accounting package, a BI tool, or software your own IT team writes. You do not need to know WinShop beforehand. Terms that are specific to WinShop are explained where they first appear.
Where to start
Getting started
Base URL, authentication, JSON conventions and error handling. Read this first.
Concepts
How lists, reference tables, documents and the catalog work across the whole API.
Reference
Every endpoint with its parameters, request and response schemas and code samples.
If you have a concrete job to do, the guides walk through it end to end:
- Product catalog sync: mirror products into an e-shop.
- Stock levels sync: keep availability up to date.
- E-shop orders: push orders into WinShop and follow their status.
Your instance may differ
Every customer runs their own instance
There is no shared WinShop cloud API. Each customer has their own instance at their own address, and each instance is upgraded on its own schedule. An endpoint or field described here may be missing on an older instance.
The reference on this site is generated from the OpenAPI description of the WinShop demo instance. That description reports its version as 0.0.0.
To see what your instance supports:
- Call
GET /api/versionto read its release version, then compare it with the changelog. This endpoint is available from the next API release; an older instance answers404. - Open
https://<your-instance>/swaggerfor the OpenAPI description served by the instance itself. That is always the exact truth for that instance.
curl https://<your-instance>/api/version{
"version": "2026.10",
"product": "WinShop Web API"
}Getting access and help
Credentials are issued by WinShop support. Write to [email protected] with the name of the customer you integrate with and what your integration needs to read and write. The same address handles questions and problem reports.