Skip to main content

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.

Function List​

Here's the reformatted list following the structure you provided:

newInventoryOperation​

Generates an empty non-persisted Inventory Operations object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveInventoryOperation method in order to persist the record. Returns a JSON representation of the newly created Inventory Operation object.

saveInventoryOperation​

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

getInventoryOperationsByOperation​

Retrieves all the Inventory Operations records for a given operation. Returns a list of JSON objects representing all inventory operations for a given operation.

getInventoryOperationsByLocation​

Retrieves all the Inventory Operations records at a given location. Returns a list of JSON objects representing all inventory operations at the given location.

getInventoryOperations​

Retrieves all the Inventory Operations records. Returns a list of JSON objects representing all inventory operations.

getInventoryOperationReferences​

Retrieves a list of references to an Inventory Operations object by its ID. Returns a list of JSON objects.

getInventoryOperationStatus​

Retrieves the status of an Inventory Operations object by its ID. Returns the status of the inventory operation.

validateInventoryOperation​

Validates the specified parameters for an Inventory Operations record and returns any validation errors. This only checks if the inventory operation object can be saved based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

deleteInventoryOperation​

Deletes an Inventory Operations record by its ID. This cannot delete an inventory operation with references to it. If successful, an ApiResponse Object is returned with the success bool set True.

executeInventoryOperation​

Executes an Inventory Operations object and creates a new inventory lot record without having to start and then stop the operation. If Inventory Operations object is already started, this will act as a stopInventoryOperation. Returns a JSON object of the inventory lot record for the executed inventory operation.

startInventoryOperation​

Starts an Inventory Operations object. Returns a JSON object of the inventory lot record for the start of the inventory operation.

stopInventoryOperation​

Stops an Inventory Operations object. Returns a JSON object of the inventory lot record for the end of the inventory operation.

cancelInventoryOperation​

Cancels an Inventory Operations object. Returns a JSON object of the inventory lot record for the cancelled inventory operation.

updateInventoryOperationStatesFromDatabase​

No Parameter: Updates the states of all the Inventory Operations from the database.

With a Parameter: Updates the states of only the specified Inventory Operations from the database given the ID of the inventory operations.

If successful, no response is returned.

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