Skip to main content

Stock Corrections

1. Overview​

The Stock Corrections API provides a programmatic way to manage and record adjustments to inventory levels. It is designed specifically for handling changes that occur outside of standard commercial transactions (like sales, customer returns, or supplier deliveries).

This API is essential for maintaining accurate inventory records by accounting for real-world events. Common use cases include:

  • Damage: Recording items that were broken or damaged in the store.
  • Theft & Loss: Adjusting stock levels to account for shrinkage or stolen goods.
  • Promotional Use: Writing off items used for in-store displays or as samples.
  • Receiving Errors: Correcting mistakes made during the goods-receiving process.
  • Expiry: Removing expired or spoiled goods from sellable stock.

2. Core Concept: Reason Codes​

Every stock correction is a data point. To make that data meaningful, a reasonCode is mandatory for every adjustment made through this API.

This requirement is crucial for business intelligence and operations. It ensures full traceability for every stock movement, providing valuable insights for:

  • Auditing: Creating a clear and unambiguous log of all inventory changes.
  • Reporting: Accurately tracking the causes of inventory shrinkage (e.g., how much value is lost to damage vs. theft).
  • Operational Improvements: Identifying patterns, such as frequent damages in a specific area, that may require action.

Note: These reason codes must be pre-configured in the system using the Configuration module.

3. API Reference​

The OpenAPI specification serves as the single source of truth for all technical details of the API.