CStoreOffice® Support & Learning

Itemized Inventory

The Itemized Inventory Business Documents API is a RESTful service that provides access to on-hand itemized inventory data in JSON format. By default, the response is updated daily, offering aggregated information about all items available at each location (station) at the time of aggregation, including:

  • Item attributes;
  • Current retail price;
  • On-hand inventory.

Prerequisites

To enable Itemized Inventory Business Documents data aggregation for the specific location, please submit a ticket to Petrosoft with the following details:

  • Name and unique identifier of the location (station).
  • How often the itemized inventory data should be prepared. By default, data collection occurs once a day.

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 at the specified intervals (by default - 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.

See also