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.

The data is saved as a JSON document to the <Location ID>/reports-exported/<Date> directory.

Location ID: Unique identifier of the location (station) in CStoreOffice®, for example, "12345".
Date: The date for which the report is prepared in <4-digit year><2-digit month><2-digit day> format, for example, "20241129".

The JSON document file name is generated according to the following naming convention: report-exported_<Timestamp>-<GIUD>.json.

Timestamp: The date and time with a seconds precision when the report was prepared in ISO 8601 format: <4-digit year><2-digit month><2-digit day>T<2-digit hour><2-digit minute><2-digit second>. For example: "20241129T223005".
GUID: The unique identifier of the report in the form of UUID (Universally Unique Identifier).

For example: 12345/reports-exported/20241129/report-exported_20241129T223005-b4e70701-1aa2-4d4d-bf83-1e3679a5951c.json.

Data structure

The itemized inventory business document is presented as an array of objects with the following structure:


[
    {
        "name": "HD Vanilla 3/$0.99",
        "category": "OTHER TOBACCO",
        "size": "3PK",
        "quantity": -34,
        "price": 99,
        "external_id": "81889201459",
        "upc": "81889201459",
        "image_url": "",
        "location": "",
        "description": "",
        "brand": "Good Times Dominicana SA",
        "unit_count": 1,
        "active": true
    }
]

The code above describes a single item. The actual document will include multiple objects with the same structure, separated by commas.
Click here to download the sample itemized inventory business document with 3 items.

Key	Type	Mandatory	Description
name	String	+	The item's name.
category	String	+	Cash register department.
size	String	+	The item's size.
quantity	Number	+	On-hand amount.
price	Number	+	Current retail price, cents.
external_id	String	+	The unique identifier of the item.
upc	String	–	PLU/UPC-A/UPC-E/EAN-13/EAN-8 with checkdigit.
image_url	String	–	Empty, reserved for future use.
location	String	–	Empty, reserved for future use.
description	String	–	Empty, reserved for future use.
brand	String	–	The item's manufacturer.
unit_count	Number	–	Always 1.
active	Boolean	+	Always true.