Orderwerks REST API

The Orderwerks REST API lets integrators read and write customers (vendors), catalogs, catalog items, price groups and orders for a supplier account.

Base URL: https://owapi.orderwerks.com

Every request must carry one of the two header sets below. The REST API reference shows which set each endpoint accepts.

API key and secret (recommended for integrations)

x-apiKey: <your api key>
x-apiSecret: <your api secret>

Requests authenticated this way run as the supplier's master user. Add a vendorGuid header to act in the context of one customer (required by the order endpoints that create orders for a customer), and optionally a userGuid header to attribute the call to a specific user.

User session headers (used by the Orderwerks web and mobile apps)

userGuid: <user guid>
userToken: <JWT issued at login>
supplierGuid: <supplier guid>
vendorGuid: <vendor guid, optional>

API keys are created in the Orderwerks web app under Business Settings. The secret is shown once, at creation.

• Paths are versioned per resource (/v1/..., /v2/...); a few legacy paths have no version segment.
• Responses are JSON. There is no common envelope; each endpoint documents its own shape.
• Paged list endpoints take limit (default 25, maximum 100) and offset. offset is a page number, not a row count: the server skips offset * limit rows.
• Delta sync: list endpoints that return serverTimestamp accept it back as lastUpdatedAt on the next call to fetch only rows changed since then. Soft-deleted rows are included in delta responses with deleted_at set.
• Errors return 4xx/5xx with a JSON body of the form { "message": "..." }. A few legacy endpoints return a plain-text message instead; those are noted individually.

Open the REST API reference for the full endpoint list.