The Itemized Inventory Business Documents API is a RESTful service that provides access to on-hand itemized inventory data in JSON format. The API returns aggregated information about all items available at each location (station) at the time of aggregation, including:
- Item attributes;
- Current retail price;
- On-hand inventory.
Itemized inventory data is aggregated and published as JSON documents on a daily basis (once every 24 hours.)
Prerequisites
The aggregation and publishing of the itemized inventory business documents for the specific location begin automatically once you purchase and activate the Business Documents API subscription.
Any active CStoreOffice® user account, regardless of role or permissions, can be used to authorize access to the Business Documents API. However, we recommend creating a dedicated service account specifically for API access, rather than using your existing account for the CStoreOffice® console.
Itemized inventory business document format
The itemized inventory business document is generated based on CStoreOffice®Itemized Inventory by Tags report data once a day. The information about a location's inventory reflects the available items, their attributes, on-hand amount, and retail price at the time of document preparation.
For more information on the itemized inventory business document data structure, read the Itemized Inventory Business Document Format article.
Calling itemized inventory API
For instructions on receiving the pre-generated itemized inventory business document via the API, read Calling Itemized Inventory API article.
