[OPTIONAL] Fixed Location Specific Status Override
Adding a Fixed Location Specific Status Override
FixedLocations can have additional data points added to a location. To create FixedLocations with specific shipment status overrides, add the parameters below:
Parameter | Type | Description |
---|---|---|
EarlyShipmentStatusMinutes | Integer | Number of minutes to determine if a shipment is considered early. |
OnTimeShipmentStatusMinutes | Integer | Number of minutes to determine if a shipment is considered on time. |
InJeopardyShipmentStatusMinutes | Integer | Number of minutes to determine if a shipment is considered in jeopardy. |
LateShipmentStatusMinutes | Integer | Number of minutes to determine if a shipment is considered late. |
HasEarlyShipmentStatusDefined | Boolean | When supplied a FALSE, it is a NO |
HasInJeopardyStatusDefined | Boolean | When supplied a FALSE, it is a NO |
FixedLocation with a Specific Status Override
Here is an example of a valid FixedLocation JSON Object with a specific status override:
{
"FixedLocationName": "Location with On-Time Rules",
"FixedLocationCode" : "OTRDEFINED",
"fixedLocationPoint": {
"latitude": 40.0207039,
"longitude": -105.2391367
},
"FixedLocationType":"1",
"overrideDeliveryStatusFlag" : true,
"hasEarlyStatusDefined": false,
"hasInJeopardyStatusDefined": false,
"earlyShipmentStatusMinutes": null,
"onTimeShipmentStatusMinutes": 240,
"inJeopardyShipmentStatusMinutes": null,
"lateShipmentStatusMinutes":240
}
Success Response:
{
"fixedLocationType": "Generic",
"fixedLocationName": "Location with On-Time Rules",
"streetAddressLine1": null,
"streetAddressLine2": null,
"cityName": null,
"stateCode": null,
"postalCode": null,
"countryCode": null,
"fixedLocationPoint": {
"latitude": 40.0207039,
"longitude": -105.2391367
},
"fixedLocationCode": "OTRDEFINED",
"organizationReferenceCode": "112222",
"overrideDeliveryStatusFlag": true,
"geofenceRadiusInFeet": null,
"earlyShipmentStatusMinutes": null,
"onTimeShipmentStatusMinutes": 240,
"inJeopardyShipmentStatusMinutes": null,
"lateShipmentStatusMinutes": 240,
"hasEarlyStatusDefined": false,
"hasInJeopardyStatusDefined": false,
"dwellTimeMinutes": null,
"isActiveFlag": false,
"lastUpdatedDate": "2018-08-12T18:13:30.2671816+00:00",
"geofencePolygon": null,
"allowGeofenceRewind": false
}
Updated about 2 months ago