# Get a list of Locations for a Facility

Get a list of Locations for a Facility

Endpoint: GET /v1/api/pub/lists/facilities/{facilityId}/locations/query
Version: 1.0
Security: Authorization

## Path parameters:

  - `facilityId` (string, required)

## Query parameters:

  - `strid` (string)
    Search by location Id

## Response 200 fields (application/json):

  - `id` (string)

  - `ncode` (integer)

  - `createdby` (string)

  - `createdon` (string)

  - `modifiedon` (string)

  - `locale` (string)
    Enum: "pt_BR", "es_MX", "fr_FR", "en_US", "de_DE", "zh_CN"

  - `nodelete` (boolean)

  - `facility_id` (string)

  - `tmplt_id` (string)

  - `aisle_details_id` (string)

  - `enabled` (boolean)

  - `notes` (string)

  - `strid` (string)

  - `strcd` (string)

  - `aislesz` (string)

  - `levelsz` (string)

  - `slotsz` (string)

  - `description` (string)

  - `aisleint` (integer)

  - `levelint` (integer)

  - `slotint` (integer)

  - `belowloc` (string)

  - `aboveloc` (string)

  - `leftloc` (string)

  - `rightloc` (string)

  - `frontloc` (string)

  - `backloc` (string)

  - `coord_x` (number)

  - `coord_y` (number)

  - `coord_z` (number)

  - `yard_equip_id` (string)

  - `facility_equip_id` (string)

  - `tmplt` (object)

  - `tmplt.id` (string)

  - `tmplt.ncode` (integer)

  - `tmplt.createdby` (string)

  - `tmplt.createdon` (string)

  - `tmplt.modifiedon` (string)

  - `tmplt.enabled` (boolean)

  - `tmplt.name` (string)

  - `tmplt.description` (string)

  - `tmplt.notes` (string)

  - `tmplt.nodelete` (boolean)

  - `tmplt.si` (string)

  - `tmplt.type` (string)
    Enum: "GENERALPURPOSE", "DOCKDOOR", "STAGING", "LABELING", "QC", "PICKAUDIT", "PACK", "HOLD", "DAMAGED", "QUARANTINE", "CROSSDOCK", "PROJECT", "PICKFACE", "RESERVE", "AISLE", "ENDCAP", "CART", "MH", "HUMAN", "YARD"

  - `tmplt.securitylevel` (integer)

  - `tmplt.zone` (string)

  - `tmplt.pickable` (boolean)

  - `tmplt.resvseq` (integer)

  - `tmplt.pickseq` (integer)

  - `tmplt.putawayseq` (integer)

  - `tmplt.pickface` (boolean)

  - `tmplt.reserve` (boolean)

  - `tmplt.sdock` (boolean)

  - `tmplt.sstage` (boolean)

  - `tmplt.rdock` (boolean)

  - `tmplt.rstage` (boolean)

  - `tmplt.project` (boolean)

  - `tmplt.wt` (number)

  - `tmplt.wt_mode` (string)
    Enum: "LBS", "KGS"

  - `tmplt.cube` (number)

  - `tmplt.cube_mode` (string)
    Enum: "CF", "CM"

  - `tmplt.temp_min` (number)

  - `tmplt.temp_max` (number)

  - `tmplt.temp_mode` (string)
    Enum: "F", "C"

  - `tmplt.max_number_lpn` (integer)

  - `tmplt.onhand_enable` (boolean)

  - `tmplt.damaged_enable` (boolean)

  - `tmplt.hold_enable` (boolean)

  - `tmplt.quarantine_enable` (boolean)

  - `tmplt.qa_enable` (boolean)

  - `tmplt.each_enabled` (boolean)

  - `tmplt.ip_enabled` (boolean)

  - `tmplt.case_enabled` (boolean)

  - `tmplt.pallet_enabled` (boolean)

  - `tmplt.auto_break_lpn` (boolean)

  - `tmplt.auto_convert_status` (string)
    Enum: "FOREIGNENTITY", "PICKEDUP", "INTRANSITRECEIVE", "INGATE", "UNLOADED", "QC", "ONHAND", "SAFETY", "ONHANDBYPASSPUTAWAY", "RESERVEDWITHORDER", "RESERVEDWITHOUTORDER", "SCRAP", "DAMAGED", "HOLD", "QUARANTINE", "INPROJECT", "ALLOCATED", "LOADED", "SHIPPED", "OUTGATE", "INTRANSITSHIP", "DELIVERED"

  - `tmplt.auto_convert_uom` (string)
    Enum: "EACH", "IP", "CASE"

  - `tmplt.velocity_unknown` (boolean)

  - `tmplt.velocity_a` (boolean)

  - `tmplt.velocity_b` (boolean)

  - `tmplt.velocity_c` (boolean)

  - `tmplt.velocity_d` (boolean)

  - `tmplt.requires_equip` (boolean)

  - `tmplt.equip_type` (string)
    Enum: "VERT_HEAVY_WIREGUIDED", "VERT_HEAVY", "NONVERT_CART", "NONVERT_PALLET_JACK", "NONVERT_HUMAN", "MATERIAL_HANDLING"

  - `subLocations` (array)

  - `aisleDetails` (object)

  - `aisleDetails.id` (string)

  - `aisleDetails.createdby` (string)

  - `aisleDetails.createdon` (string)

  - `aisleDetails.modifiedon` (string)

  - `aisleDetails.facility_id` (string)

  - `aisleDetails.enabled` (boolean)

  - `aisleDetails.num_hpos` (integer)

  - `aisleDetails.num_vpos` (integer)

  - `aisleDetails.name` (string)

  - `aisleDetails.description` (string)

  - `aisleDetails.notes` (string)

  - `facility` (object)

  - `facility.id` (string)

  - `facility.ncode` (integer)

  - `facility.createdby` (string)

  - `facility.createdon` (string)

  - `facility.modifiedon` (string)

  - `facility.enabled` (boolean)

  - `facility.type` (string)
    Enum: "WAREHOUSE", "TERMINAL", "DEPOT", "VIRTUAL"

  - `facility.code` (string)

  - `facility.accounting_ref` (string)

  - `facility.name` (string)

  - `facility.description` (string)

  - `facility.notes` (string)

  - `facility.address1` (string)

  - `facility.address2` (string)

  - `facility.address3` (string)

  - `facility.address4` (string)

  - `facility.city` (string)

  - `facility.state_province` (string)

  - `facility.postal_code` (string)

  - `facility.country` (string)

  - `facility.contact_name` (string)

  - `facility.contact_phone` (string)

  - `facility.contact_email` (string)

  - `yard_equip` (object)

  - `yard_equip.id` (string)

  - `yard_equip.ncode` (integer)

  - `yard_equip.createdby` (string)

  - `yard_equip.createdon` (string)

  - `yard_equip.modifiedon` (string)

  - `yard_equip.enabled` (boolean)

  - `yard_equip.scac` (string)

  - `yard_equip.strid` (string)

  - `yard_equip.type` (string)
    Enum: "CONTAINER_20", "CONTAINER_40", "CONTAINER_40HC", "DRYVAN53", "REFER53", "TRAILER", "CHASSIS", "TRUCK", "USERDEF"

  - `yard_equip.type_description` (string)

  - `yard_equip.owner_coname` (string)

  - `yard_equip.owner_phone` (string)

  - `yard_equip.owner_email` (string)

  - `yard_equip.description` (string)

  - `yard_equip.notes` (string)

  - `yard_equip.max_weight` (number)

  - `yard_equip.wt_mode` (string)
    Enum: "LBS", "KGS"

  - `yard_equip.max_cube` (number)

  - `yard_equip.cube_mode` (string)
    Enum: "CF", "CM"

  - `facility_equip` (object)

  - `facility_equip.id` (string)

  - `facility_equip.ncode` (integer)

  - `facility_equip.createdby` (string)

  - `facility_equip.createdon` (string)

  - `facility_equip.modifiedon` (string)

  - `facility_equip.enabled` (boolean)

  - `facility_equip.facility_id` (string)

  - `facility_equip.assignedto_id` (string)

  - `facility_equip.type` (string)
    Enum: "VERT_HEAVY_WIREGUIDED", "VERT_HEAVY", "NONVERT_CART", "NONVERT_PALLET_JACK", "NONVERT_HUMAN", "MATERIAL_HANDLING"

  - `facility_equip.name` (string)

  - `facility_equip.description` (string)

  - `facility_equip.notes` (string)

  - `facility_equip.vertical` (boolean)

  - `facility_equip.max_weight` (number)

  - `facility_equip.max_cube` (number)

  - `facility_equip.max_number_pallets` (integer)

  - `facility_equip.max_slots` (integer)


