API documentation
How to use the Xoopar API
Answers to the questions we hear most from customers connecting to Xoopar's product catalog through the API.
It's a secure gateway that lets you pull Xoopar's product catalog directly into your own systems — your e-commerce site, ERP, or PIM.
Contact your Xoopar account manager. They will set up your API account and send you a username and password. There is no self-service sign-up — every account is configured on our side so it returns the correct prices and language for you from the start.
Every request uses HTTP Basic Authentication — the standard login method supported by virtually every integration tool, ERP connector, and programming language. You send your username and password with each request; there's no separate login step, session, or token to manage.
Two things, depending on what you need:
- The full catalog — every product available to your account, returned in a single response. The Middleware handles all the pagination on our side, so you don't have to make repeated requests.
- A single product — one item, looked up by its product code. Handy for spot-checking or refreshing one product at a time.
Only the prices assigned to your account. Each customer has their own dedicated price in our catalog, and the API automatically filters out every other customer's pricing before the data reaches you.
Images and files are served through links rather than pointing to our internal systems. You can download them or embed the links directly in your own site or ERP.
Every call to the catalog endpoint queries our product system live, so what you get back is always current at the moment you ask. There is no enforced rate limit today, but since a full-catalog request re-fetches and re-processes every product each time, we recommend polling once or twice a day rather than continuously
The full-catalog endpoint always returns every product in a single response. There's nothing extra to implement on your side as the catalog grows.
Yes — stock levels are included directly in the product data, no separate endpoint needed.
Field names and values come through translated into your language, so most fields are self-explanatory as returned (e.g. a printing-type or NFC/magnetic attribute will show a readable label rather than an internal code). A dedicated field-by-field reference document is a work in progress — we'll share it once it's ready.
Today, prices are returned in EUR only. Support for GBP pricing is a work in progress — we'll let you know as soon as it's available.
A few practical details to hand to your developer or integrator:
- All endpoints require HTTP Basic Auth and return JSON.
GET /api/products— full catalog, already paginated for you server-side.GET /api/products/{code}— a single product by its code.GET /api/media-files/{code}— download a proxied product image or file.