api.hirepos.com/API/SalesStockLevels

The SalesStockLevels endpoint serves as a polling feed designed to retrieve the sales stock quantities of active items. This endpoint returns data in a CSV file format, which includes the columns for Code and Qty In Stock.
⚠️ Please note the Branches module or branch-specific data is not supported in any way at this stage.

The SalesStockLevels feed should be polled at regular intervals, such as every few hours, to maintain reasonably accurate sales stock quantities for your third-party online store (e.g., Shopify).

To access the SalesStockLevels endpoint, you need to make a GET request to the designated URL. The response will include an array in CSV format, featuring a header row for the Code and Qty In Stock columns, along with a row for each active sales item. Additionally, you have the option to include a Recalc parameter with a value of True. This will allow for real-time recalculation of the Qty In Stock, rather than retrieving static field values. However, please be aware that this option may have significant performance implications.

Below is an example of how to make a request to the SalesStockLevels endpoint:

GET https://api.hirepos.com/API/SalesStockLevels?Code={YourSubscriptionCode}&AuthKey={YourAPIKey}

• Code={YourSubscriptionCode}

• AuthKey={YourAPIKey}

• Recalc=True (Optional)

Code, Qty In Stock 
1000, 2
1001, 5
1002, 8