Storage nodes

Storage nodes are objects in which stock are attached.

Physical goods are tangible concrete things that exists "somewhere", and storage node is a name for that "somewhere", be it a bay, warehouse section etc. As storage nodes represent somewhere physical, every storage node references a warehouse site.

Storage nodes can have parent/child relationsips with other storage nodes, meaning you can use storage nodes to create multi-level hierarchies.

In a broad sense, warehouse site lets you know where on the map any stock is located and storage node tells you where in the warehouse site the stock is located.

Schema

Schema: Storage-node

PropertyTypeDescription
idObjectIdUnique identifier
warehouse_siteObjectIdWarehouse site where storage node is located
nameStringName of storage node
short_nameStringShort name of storage node, used for labeling
parentObjectIdParent storage node
sort_orderIntegerDetermines in which order to present this node among its siblings
archivedBooleanShould be hidden in UI if true

Get a list of storage nodes

If you want to retrieve a list of storage nodes, use this GET request:

GET https://api.tirix.io/storage-nodes

Get a storage node

If you want to fetch an individual storage node, use this GET request:

GET https://api.tirix.io/storage-nodes/{storage_node_id}

Create a new storage node

If you want to create a new storage node, use this POST request:

POST https://api.tirix.io/storage-nodes

Modify a storage node

If you want to modify a specific storage node, use this PUT request:

PUT https://api.tirix.io/storage-nodes/{storage_node_id}

Delete a storage node

Storage nodes are persistent and can not be irreversibly deleted.

TIP

You can flag the storage node to be hidden in user interfaces by modifying its 'archived' property.

Edges

Label

If you want to print a label an individual warehouse site that does not have any parents (top level), use this GET request:

GET https://api.tirix.io/storage-nodes/{storage_node_id}/label

This call will return an application/pdf resource.

Last Updated: