Locations

Master data file describing the location hierarchy: Locations → Location Areas → Bins (vessels and tanks). One row per entity, with the hierarchy expressed via a parent_name reference.

A single combined file describing the location hierarchy: Locations → Location Areas → Bins (vessels/tanks). One row per entity. The hierarchy is expressed via a parent_name reference.

Schema

#
Column
Required?
Description
Example

1

entity_type

One of: location, location_area, bin. Identifies which level of the hierarchy this row represents.

bin

2

name

Identifier. Must be unique within its entity_type.

SS-01

3

parent_name

Required for location_area and bin. The parent's name. For location_area, the parent is a location. For bin, the parent is a location_area. Empty for location rows.

North

4

description

Human-readable description.

Stainless Steel Tank 01

5

bin_type

Only used when entity_type=bin. One of: FG-BIN, Vessel-Stainless, Vessel-Barrel.

Vessel-Stainless

6

external_system_id

Only used when entity_type=bin. The client's internal identifier for the bin.

BIN-1001

Header row

entity_type,name,parent_name,description,bin_type,external_system_id

Sample data

entity_type,name,parent_name,description,bin_type,external_system_id
location,ZAM-WINERY,,"ZAM Apps Winery",,
location,ZAM-WHS,,"ZAM Apps Warehouse",,
location,ZAM-PARTNER,,"ZAM Partner Warehouse",,
location_area,North,ZAM-WINERY,"North Tank Farm",,
location_area,South,ZAM-WINERY,"South Tank Farm",,
location_area,Storage,ZAM-WHS,Storage,,
location_area,"South Storage Building",ZAM-PARTNER,"Storage Building in Southern Area",,
bin,SS-01,North,"Stainless Steel Tank 01",Vessel-Stainless,BIN-1001
bin,SS-02,North,"Stainless Steel Tank 02",Vessel-Stainless,BIN-1002
bin,SS-03,North,"Stainless Steel Tank 03",Vessel-Stainless,BIN-1003
bin,FG-GEN-BIN,Storage,"Finished Good Generic Holding Bin",FG-BIN,BIN-2001
bin,Refrigerator,"South Storage Building","Large Refrigerator",FG-BIN,BIN-3001

Snapshot semantics

  • Full snapshot every delivery. Include every active location, area, and bin.

  • A location row must appear before any location_area that references it; a location_area row must appear before any bin that references it. Order rows accordingly so a single forward-pass parser will validate cleanly.

  • Names must be unique within their entity_type.

  • Renames are not supported in-place. To rename, deliver the new name as a new row.

Last updated

Was this helpful?