{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-openapi.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi.yaml","settings":{"baseUrlPath":"/openapi"},"disableAutoScroll":true,"seo":{"title":"Orderwerks REST API"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"Orderwerks REST API","version":"1.19","description":"The Orderwerks REST API lets integrators read and write customers (vendors), catalogs, catalog items,\nprice groups and orders for a supplier account.\n\n# Authentication\n\nEvery request must carry one of two header sets. Each endpoint lists which set it accepts under\n**Authorizations**.\n\n**API key and secret** (recommended for integrations): send `x-apiKey` and `x-apiSecret`. Requests\nauthenticated this way run as the supplier's master user. Add a `vendorGuid` header to act in the\ncontext of one customer, and optionally a `userGuid` header to attribute the call to a specific user.\n\n**User session headers** (used by the Orderwerks web and mobile apps): send `userGuid`, `userToken`\n(the JWT issued at login) and `supplierGuid`, plus `vendorGuid` when acting for a customer.\n\nAPI keys are created in the Orderwerks web app under Business Settings. The secret is shown once, at creation.\n\n# Conventions\n\n- Paths are versioned per resource (`/v1/...`, `/v2/...`); a few legacy paths have no version segment.\n- Responses are JSON. There is no common envelope; each endpoint documents its own shape.\n- Paged list endpoints take `limit` (default 25, maximum 100) and `offset`. `offset` is a **page number**,\n  not a row count: the server skips `offset * limit` rows.\n- Delta sync: list endpoints that return `serverTimestamp` accept it back as `lastUpdatedAt` on the next\n  call to fetch only rows changed since then. Soft-deleted rows are included in delta responses with\n  `deleted_at` set.\n- Errors return `4xx`/`5xx` with a JSON body of the form `{ \"message\": \"...\" }`. A few legacy endpoints\n  return a plain-text message instead; those are noted individually.\n\n# Terminology\n\nOrderwerks calls the business operating the account the **supplier**, and the customers who place orders\n**vendors** (also \"accounts\" or \"customers\" in the apps). Vendor endpoints are customer endpoints.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.orderwerks.com","port":4000,"ipAddress":"216.73.216.201"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}