Skip to content

Wares ​

The wares section provides read-only access to wares, stock movements, purchase orders, and the related master data (categories, storages, distributors) of your company.

Required scope: wares

Setting up API access is described in the Help Center.

Required license

Master data (/wares, /wares/{uuid}) and ware categories (/wares/categories, /wares/categories/{uuid}) are available without an additional license. Stock, stock movements, purchase orders, storages, and distributors additionally require the Stock management add-on.

Endpoints ​

MethodEndpointDescription
GET/api/oauth/v2/resource/waresPaginated list of all wares and services
GET/api/oauth/v2/resource/wares/{uuid}Details of a single ware
GET/api/oauth/v2/resource/wares/movementsPaginated list of stock movements
GET/api/oauth/v2/resource/wares/movements/{uuid}Details of a single stock movement
GET/api/oauth/v2/resource/wares/purchasesPaginated list of open purchase orders
GET/api/oauth/v2/resource/wares/purchases/{uuid}Details of a single purchase order
GET/api/oauth/v2/resource/wares/categoriesPaginated list of ware categories
GET/api/oauth/v2/resource/wares/categories/{uuid}Details of a single ware category
GET/api/oauth/v2/resource/wares/storagesPaginated list of storages
GET/api/oauth/v2/resource/wares/storages/{uuid}Details of a single storage
GET/api/oauth/v2/resource/wares/distributorsPaginated list of distributors
GET/api/oauth/v2/resource/wares/distributors/{uuid}Details of a single distributor

License dependency ​

GET /wares, GET /wares/{uuid}, GET /wares/categories, and GET /wares/categories/{uuid} need no additional license.

GET /wares/movements, GET /wares/movements/{uuid}, GET /wares/purchases, GET /wares/purchases/{uuid}, GET /wares/storages, GET /wares/storages/{uuid}, GET /wares/distributors, and GET /wares/distributors/{uuid} require the Stock management add-on. Without it, these endpoints respond with 403 insufficient_scope.

GET /wares and GET /wares/{uuid} also depend on the add-on, but differently: instead of an error, the response is missing the stock block entirely when Stock management is not licensed. The key does not exist — it is not returned as null. See List Wares for example responses of both cases.

Full sync vs. incremental sync ​

GET /wares supports no incremental filters (updatedSince, deletedSince). Master-data changes such as price, name, or category require a full sync.

Stock changes don't need a full sync of /wares itself: every stock change creates a stock movement, and stockNew of the most recent movement per ware carries the current stock. GET /wares/movements supports createdSince/createdUntil as an incremental sync window for that.

GET /wares/purchases does not support incremental filters yet either, and only ever returns open purchase orders — completed ones are deleted, so there is no way to detect a completion incrementally. See List Purchase Orders for details.

Offisy GmbH