[OPTIONAL] Custom Geo-Fence - Radius

Adding a Geo-Fence Raduis

To create FixedLocations with a geo-fence radius, simply add the optional parameters below:

Parameter

Type

Description

GeofenceRadiusInFeet

Integer

Number of feet for the geofence radius.

• The GeofenceRadiusInFeet must be greater than 0.01 miles (52.8 feet).
• The GeofenceRadiusInFeet must be less than 5 miles (26,400 feet).

Here is an example of a completely valid FixedLocation JSON Object with a custom geo-fence:

{
  "FixedLocationName": "Location with FL Radius",
  "FixedLocationCode" : "RADIUSGOEFENCE",
  "fixedLocationPoint": {
        "latitude": 40.0207039,
        "longitude": -105.2391367
    },
  "FixedLocationType":"1",
  "GeofenceRadiusInFeet" : "200"
}

Success Response:

{
    "fixedLocationType": "Generic",
    "fixedLocationName": "Location with FL Radius",
    "streetAddressLine1": null,
    "streetAddressLine2": null,
    "cityName": null,
    "stateCode": null,
    "postalCode": null,
    "countryCode": null,
    "fixedLocationPoint": {
        "latitude": 40.0207039,
        "longitude": -105.2391367
    },
    "fixedLocationCode": "RADIUSGOEFENCE",
    "organizationReferenceCode": "112222",
    "overrideDeliveryStatusFlag": false,
    "geofenceRadiusInFeet": 200,
    "earlyShipmentStatusMinutes": null,
    "onTimeShipmentStatusMinutes": null,
    "inJeopardyShipmentStatusMinutes": null,
    "lateShipmentStatusMinutes": null,
    "hasEarlyStatusDefined": false,
    "hasInJeopardyStatusDefined": false,
    "dwellTimeMinutes": null,
    "isActiveFlag": false,
    "lastUpdatedDate": "2018-08-12T18:42:19.7943766+00:00",
    "geofencePolygon": null,
    "allowGeofenceRewind": false
}