Skip to main content
Version: V2 (Ignition 8.1)

Inventory Operation Script API

Welcome to the Inventory Operation Script API documentation. This API provides a comprehensive set of functions for managing and interacting with inventory operations within the system. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Note: All export functions return raw byte arrays (byte[]) so they can be written directly to files or downloaded. Some older documentation may have referenced String return types; these have been corrected.

Function List​

newInventoryOperation​

Generates an empty non-persisted Inventory Operation object to provide the structure required by the API to save a new record into the database. Must be combined with saveInventoryOperation to persist the record. Returns a JSON representation of the new object.

saveInventoryOperation​

Creates or updates an Inventory Operation record based on provided parameters. Returns a JSON representation of the saved inventory operation.

validateInventoryOperation​

Validates an Inventory Operation definition without saving it. Returns a JSON object mapping field names to lists of validation messages.

getInventoryOperation​

Retrieves an Inventory Operation by its unique identifier. Returns a JSON object representing the inventory operation.

getAllInventoryOperations​

Retrieves all configured Inventory Operations. Returns a JSON array.

getInventoryOperationsByOperation​

Retrieves all Inventory Operations associated with a given operation. Returns a JSON array.

getInventoryOperationsByLocation​

Retrieves all Inventory Operations at a given location (by id or path). Returns a JSON array.

getInventoryOperationReferences​

Retrieves references to an Inventory Operation by ID. Returns a JSON structure describing references.

getInventoryOperationStatus​

Retrieves the status enum of an Inventory Operation by ID.

deleteInventoryOperation​

Deletes an Inventory Operation by ID if it has no blocking references. Returns an ApiResponse.

deleteAllInventoryOperations​

Deletes multiple Inventory Operations records by their IDs.

executeInventoryOperation​

Executes an Inventory Operation in a single step. If already running, behaves like stopInventoryOperation. Returns the resulting inventory lot record.

startInventoryOperation​

Starts an Inventory Operation. Returns the started inventory lot record (open-ended).

stopInventoryOperation​

Stops a running Inventory Operation. Returns the completed inventory lot record.

cancelInventoryOperation​

Cancels a running Inventory Operation and the associated lot record. Returns the canceled lot record.

updateInventoryOperationStatesFromDatabase​

Refreshes gateway state for all or specified Inventory Operations. No return value.

importFromCsv​

Imports Inventory Operations from a CSV (byte array). Returns an ApiResponse containing the count imported/updated.

importFromJson​

Imports Inventory Operations from JSON (byte array). Returns an ApiResponse containing the count imported/updated.

exportAsCsv​

Exports all or selected Inventory Operations as CSV (byte array) for download.

exportAsJson​

Exports all or selected Inventory Operations as JSON (byte array) for download.

getInventoryOperationPermissions​

Retrieves the full list of permission role keys associated with the Inventory Operation API.

Deprecated / Removed Functions​

The following functions appeared in earlier documentation but are not available in the current API implementation:

  • isSourceLocationRequired
  • isDestinationLocationRequired

Their pages are retained only for historical reference and are marked deprecated.

Explore each function’s documentation for detailed usage examples and additional information.

Last updated on by SholomEllenbogenTamaki