ZRM Docs
Domain Model

Warehouse

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
namestringYesName
codestringYesCode
warehouseTypeenum(warehouse, staging_area, receiving_dock)YesWarehouse type
addressunknownYesAddress
isDefaultbooleanYesIs default
statusenum(active, inactive)YesStatus
notesunknownYesNotes
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
namestringYesName
codestringYesCode
warehouseTypeenum(warehouse, staging_area, receiving_dock)Yes"warehouse"Warehouse type
addressunknownNoAddress
isDefaultbooleanYesfalseIs default
statusenum(active, inactive)Yes"active"Status
notesunknownNoNotes
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
codestringNoCode
warehouseTypeenum(warehouse, staging_area, receiving_dock)No"warehouse"Warehouse type
addressunknownNoAddress
isDefaultbooleanNofalseIs default
statusenum(active, inactive)No"active"Status
notesunknownNoNotes

On this page