Skip to main content

Inventory Management

The inventory domain contains information about the stock products such as Batch and Stock levels

Inventory in Merlin?

Inventory information can be partially found in Code Entry and also in the Stock Control and Wholesale screens.

Entities within Inventory Management​

  1. Batch
  2. Levels
  3. Manufacturer
  4. Supplier

Relationships​

The inventory domain has relationships mostly with entities in the Formulary domain and Location domain. Batch data consumed in the Clinical Domain.

  1. Stock Levels and Batch information is structured by Location and Location Space, to return total stock for a Location, you must sum the stock quantity for all Location Spaces.
  2. Currently batch information does not contain quantities, only if the item is in stock.

Inventory Schema​

Please take note of the following points for this schema:

  1. Batch UUID This is not an UUID for the batch number, this is an identifier for the record. The same Batch Number may exist multile times in different Locations and Spaces and Formulary records.
  2. Levels Quantity returns the quantity at the time the request is made, no point in time or daily summary is available.

Supplier Price Updates​

To update list prices for each supplier the /suppliers/:supplier-uuid/product-lists endpoint will take all products in a single payload and if accepted will return a 200 response with a job-uuid. This process is asynchronous therefore for an update on the status or error codes then the /suppliers/product-lists/:job-uuid/status endpoint must be used to confirm the task was completed successfully or attempt to retry.

The status response will inform if it is running, completed or failed including any errors that occured.

The process does the following:

  1. Imports the entire price list.
  2. Updates the cost price of any SKU matches for the supplier.
  3. Stores the imported price list for assisting in order building to place orders (if integration exists) from Merlin.

Cross Domain UUID References​

ReferenceDomainResourceNote
location-uuidlocation-management/locationsLocation, e.g. work location.
location-space-uuidlocation-management/locations/:uuid/spacesSpace the item was used from, e.g. stock location.
formulary-uuidformulary-management/services, /stockIdentifies the formulary configuration used to create the work.

Security Scopes​

The following authorisation scopes are required to access different resources within this domain:

  • inventory:read
  • inventory:meta:read