# Find location with an propertyId

Endpoint: GET /locations/propertyLookup/{propertyId}
Version: 1.0.0
Security: M2X_auth_application

## Path parameters:

  - `propertyId` (string, required)
    The property Id

## Query parameters:

  - `value` (string, required)
    The property value

## Response 200 fields (application/json):

  - `locationKind` (string,null)
    Enum: "Farm", "Carrier", "Port", "Warehouse", "Sale Yard", "Holding Yard", "Works", "Weighbridge", "Accommodation", "Quarry", "Mine", "Store", "Plant", "Forest", "Ranch", "Growyard", "Elevator", "Feedyard", "Depot", "Pack Site", "Container Depot"

  - `shortName` (string, required)
    Example: "Dreamy Farm"

  - `areaName` (string,null)
    Example: "Mystery Creek"

  - `facilityName` (string,null)
    Example: "Main Yards"

  - `addressText` (string,null)
    Example: "Main Yards"

  - `latitude` (number,null)
    If null or not provided, the latitude from the current location will be retained.  If there is no current latitude, it will be resolved by geocoding.

  - `longitude` (number,null)
    If null or not provided, the longitude from the current location will be retained.  If there is no current longitude, it will be resolved by geocoding.

  - `externalId` (string,null)
    An optional external identifier assigned to the location. This ID can be provided when creating the location and is typically used for cross-system referencing or integration with external data sources.

  - `inboundIntegrationIds` (array,null)

  - `disabled` (boolean, required)

  - `onHold` (boolean)

  - `customer` (object,null)
    At least one field needs to be provided to resolve the customer

  - `customer.customerId` (string)
    M2X customer ID

  - `customer.customerName` (string)
    Customer name

  - `customer.integrationId` (string)
    Customer integration ID

  - `customer.externalId` (string)
    External customer ID

  - `mobile` (string,null)
    Location mobile number
    Example: "+33 123"

  - `phone` (string,null)
    Location phone number
    Example: "+33 123"

  - `email` (string,null)
    Location email
    Example: "asd@asd.asd"

  - `hazards` (string,null)
    Hazards descriptions

  - `notes` (string,null)
    Notes

  - `properties` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `requirements` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `restrictions` (object,null)
    A key value store containing bespoke properties usable for pricing and optimisation

  - `metadata` (object,null)
    Opaque passenger data

  - `readonlyFields` (object,null)
    Specifies which field should not be touched by the user

  - `readonlyFields.latitude` (boolean)

  - `readonlyFields.longitude` (boolean)

  - `readonlyFields.notes` (boolean)

  - `readonlyFields.hazards` (boolean)

  - `readonlyFields.externalId` (boolean)

  - `readonlyFields.customer` (boolean)

  - `readonlyFields.mobile` (boolean)

  - `readonlyFields.phone` (boolean)

  - `readonlyFields.email` (boolean)

  - `readonlyFields.gtnCaptureRequiredPickup` (boolean)

  - `readonlyFields.gtnCaptureRequiredDelivery` (boolean)

  - `readonlyFields.openingHours` (boolean)

  - `accessLatitude` (number,null)

  - `accessLongitude` (number,null)

  - `maxIncomingWeight` (number,null)

  - `maxOutgoingWeight` (number,null)

  - `minIncomingWeight` (number,null)

  - `minOutgoingWeight` (number,null)

  - `offRoadDistance` (number,null)

  - `offRoadDuration` (number,null)

  - `waitTime` (number,null)

  - `contactName` (string,null)

  - `contactNotes` (string,null)

  - `dairySupplyGeneration` (object,null)

  - `geofenceType` (string,null)
    Enum: "Circular", "Polygon", null

  - `polygonGeofence` (string,null)
    If geofenceType is "Polygon" uses this WKT closed polygon (last and first lat/long pair must match)
    Example: "POLYGON ((-105.0105 39.7617,-105.0108 39.7614,-105.0111 39.7616,-105.0105 39.7617))"

  - `radius` (integer,null)
    If geofenceType is "Circular" uses this integer radius in meters around the determined or provided lat/long
    Example: 300

  - `geofenceAlerting` (object,null)

  - `geofenceAlerting.enabled` (boolean, required)

  - `geofenceAlerting.emails` (array,null)
    A list of email addresses
    Example: ["abc@example.com"]

  - `geofenceAlerting.mobileNumbers` (array,null)
    A list of mobile numbers
    Example: [64211234567]

  - `gtnCaptureRequiredPickup` (string,null)
    Policy for weighbridge input on pickup
    Enum: "MANDATORY", "OPTIONAL", "NONE", null

  - `gtnCaptureRequiredDelivery` (string,null)
    Policy for weighbridge input on delivery
    Enum: "MANDATORY", "OPTIONAL", "NONE", null

  - `weeklySupplyGeneration` (object,null)

  - `weeklySupplyGeneration.interactionsInstructions` (array,null)

  - `weeklySupplyGeneration.interactionsInstructions.storageId` (string, required)

  - `weeklySupplyGeneration.interactionsInstructions.storageName` (string,null)

  - `weeklySupplyGeneration.interactionsInstructions.capacity` (object)

  - `weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelMinPumpableLitres` (number,null)

  - `weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelSafeFillLitres` (number,null)

  - `weeklySupplyGeneration.interactionsInstructions.capacity.capacityFuelSafetyStockLitres` (number,null)

  - `weeklySupplyGeneration.interactionsInstructions.capacity.capacityLitres` (number,null)

  - `weeklySupplyGeneration.interactionsInstructions.product` (object)

  - `weeklySupplyGeneration.interactionsInstructions.product.productCodeId` (string, required)

  - `weeklySupplyGeneration.interactionsInstructions.product.productCodeName` (string, required)

  - `weeklySupplyGeneration.interactionsInstructions.product.productId` (string, required)

  - `weeklySupplyGeneration.interactionsInstructions.product.productLinearRate` (number,null)

  - `weeklySupplyGeneration.interactionsInstructions.productLinearRateCalculated` (boolean)

  - `weeklySupplyGeneration.defaultProductEnabled` (boolean)

  - `weeklySupplyGeneration.dayCollectionWindow` (object,null)

  - `weeklySupplyGeneration.dayCollectionWindow.startTime` (string,null)
    The start of the collection/delivery time window.  May extend past 24:00 for overnight time windows.
    Example: "07:00"

  - `weeklySupplyGeneration.dayCollectionWindow.endTime` (string,null)
    The end of the collection/delivery time window.  May extend past 24:00 for overnight time windows.
    Example: "28:00"

  - `weeklySupplyGeneration.generationBasis` (string,null)
    Enum: "PATTERN", "SAFETY_STOCK"

  - `weeklySupplyGeneration.patternType` (string,null)
    Enum: "TWICE_WEEKLY", "WEEKLY", "FORTNIGHTLY", "THIRD_WEEK", "FOURTH_WEEK", "FIVE_DAYS", "CUSTOM"

  - `weeklySupplyGeneration.pattern` (array,null)

  - `weeklySupplyGeneration.pattern.monday` (object, required)

  - `weeklySupplyGeneration.pattern.monday.day` (boolean)

  - `weeklySupplyGeneration.pattern.monday.night` (boolean)

  - `weeklySupplyGeneration.pattern.tuesday` (object, required)

  - `weeklySupplyGeneration.pattern.wednesday` (object, required)

  - `weeklySupplyGeneration.pattern.thursday` (object, required)

  - `weeklySupplyGeneration.pattern.friday` (object, required)

  - `weeklySupplyGeneration.pattern.saturday` (object, required)

  - `weeklySupplyGeneration.pattern.sunday` (object, required)

  - `weeklySupplyGeneration.patternStartDay` (string,null)
    YYYY-MM-DD
    Example: "2024-01-01"

  - `weeklySupplyGeneration.customPriority` (string,null)
    Enum: "HIGH", "MEDIUM", "LOW"

  - `weeklySupplyGeneration.isTopupSite` (boolean)

  - `weeklySupplyGeneration.productQuantity` (number,null)

  - `id` (string)
    Example: "D001"

  - `updated` (string,null)

## Response 404 fields (application/json):

  - `message` (string)
    Example: "not found"