Location

Contains details of shelf locations in a store.

Field name Description mSupply Use Reference link Type
ID UUID of the record Not use in UI Alpha
Colour colour of the record when displayed in lists Alpha
code a short code for the location Locations»Code https://docs.msupply.org.nz/items:item_locations?s[]=location#adding_a_location Alpha
Description Full description of the location Locations»Description https://docs.msupply.org.nz/items:item_locations?s[]=location#adding_a_location Alpha
Comment For your use to record any info Locations»Comment https://docs.msupply.org.nz/items:item_locations?s[]=location#comment Text
hold if true, stock at this location can't be issued on customer invoices- can use for quarantine areas. Locations»holdhttps://docs.msupply.org.nz/items:item_locations?s[]=location#hold boolean
parent_ID UUID of the parent of this location (e.g the rack of a particular slot, or the aisle of a rack Id are not shown in UI but used to display Locations»Parenthttps://docs.msupply.org.nz/items:item_locations?s[]=location#parent Alpha
priority numeric value that can be used for sorting locations for picking Locations»priorty https://docs.msupply.org.nz/items:item_locations?s[]=location#priority Long int
store_ID UUID of the store that this location is for not use in UI Alpha
summary_only True means that the location is a summary location, only to be used for reporting, not for assigning to stock (e.g. an aisle that has racks as children) Locations»Summary https://docs.msupply.org.nz/items:item_locations?s[]=location#summary Boolean
type_ID UUID of Location_type record that this record is related to. Location types can be used to restrict storage of items to certain location (types) ID are not shown in UI but used to display Locations»Location type https://docs.msupply.org.nz/items:item_locations?s[]=location#location_type Alpha
Volume Total volume of this location in cubic metres (m3) Locations»Volume https://docs.msupply.org.nz/items:item_locations?s[]=location#total_volume Real number
object_type Alpha
bottom_y_coordinate Position of the bottom edge of this location. Used for displying the locaiton on a diagram. Old functionality not used any more real number
replenishment_type this is where you tell mSupply if this shelf location is a Pickface or a Bulk location (or neither, if you leave it set at None) Locations»Replenishment location type https://docs.msupply.org.nz/items:item_locations?s[]=location#replenishment_location_type Alpha
asset_ID Links the location to an asset recorded in mSupply Locations»This location is a part of asset https://docs.msupply.org.nz/items:item_locations?s[]=location#asset_this_location_is_part_of Alpha
Field number Field Name Description Type Length Index
3enter_date Date
4enter_time Time
5exit_date Date
6exit_time Time
1ID Unique ID of the record Alpha Y
7item_line_ID Alpha
2location_ID Alpha
8store_ID Alpha
  • Last modified: 2026/01/07 06:30
  • by Raksha Khadka