The Catalog API lets a retailer pull the catalog of the brands it is connected to on JOOR, and stay in sync as that catalog changes.
It has two halves, designed to be used together:
- The Read API. Paginated
GETendpoints that walk your catalog: connections, then a brand's collections, then a collection's products, then a product's full detail. There is a bulk mode that returns whole pages of full product detail, which is how you seed your copy. - Change webhooks. You register an HTTPS callback and JOOR posts a signed notification whenever a product you can see changes, enters your catalog, or leaves it. Each notification carries the complete current data for whatever changed, so you apply it directly. Re reading through the Read API is available for reconciliation but is never required.
What you can build
| Use case | How |
|---|---|
| Mirror a brand's catalog into your PIM | Seed with the bulk export, then apply webhooks |
| Keep prices and availability current | Subscribe to product.updated; the skus section carries the complete price set |
| Detect products entering or leaving your assortment | Subscribe to product.created and product.deleted |
| Build a buying tool over live linesheets | Walk collections, then products at summary depth for grids and full depth for detail pages |
| Reconcile nightly | Re-walk connections and collections; both are cheap |
In this section
- Quickstart — six calls, in order, that get you from zero to synced
- Making Requests — the response envelope, pagination, dates, and identifiers
- Rate Limits & Errors — the credit system, and every status code and error you will see
This section covers the basics: how to make your first call, how the whole catalog fits together, and the rules that apply to every request. The Read API and Webhooks sections that follow assume you have read this part.