[OPTIONAL] Dwell Time Buffer
In order to manage dwell time expectations by location, we have added the ability to add a dwell time buffer which is used to buffer the amount of time between when the anticipated dwell time has passed and when a notification is sent if a notification is setup. To add this optional value, use the parameters below:
dwellTimeBufferMinutes | The amount of time, in minutes, that a notification should be delayed by before sending if the anticipated dwell time has passed. Max allowed minutes is 1,440 (24 hours). |
Sample Fixed Location object with load and unload times:
{
"FixedLocationName": "Dwell Time Buffer Example",
"FixedLocationCode" : "DWELLBUFFER",
"FixedLocationPoint" :
{
"Latitude": 50.1234,
"Longitude": -45.5432
},
"FixedLocationType":"1",
"dwellTimeBufferMinutes": 30
}
Example Response:
{
"fixedLocationType": "Generic",
"fixedLocationName": "Dwell Time Buffer Example",
"streetAddressLine1": "NL-1",
"streetAddressLine2": null,
"cityName": "Raleigh",
"stateCode": "NL",
"postalCode": null,
"countryCode": "CA",
"fixedLocationPoint": {
"latitude": 50.1234,
"longitude": -45.5432
},
"fixedLocationCode": "DWELLBUFFER",
"organizationReferenceCode": null,
"overrideDeliveryStatusFlag": false,
"geofenceRadiusInFeet": null,
"earlyShipmentStatusMinutes": null,
"onTimeShipmentStatusMinutes": null,
"inJeopardyShipmentStatusMinutes": null,
"lateShipmentStatusMinutes": null,
"hasEarlyStatusDefined": false,
"hasInJeopardyStatusDefined": false,
"dwellTimeMinutes": null,
"isActiveFlag": false,
"lastUpdatedDate": "2019-04-08T16:46:19.5341452+00:00",
"geofencePolygon": null,
"allowGeofenceRewind": false,
"dwellTimeBufferMinutes": 30,
"operatingHours": [
{
"dayOfWeek": "Sunday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Monday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Tuesday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Wednesday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Thursday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Friday",
"startTime": "00:00:00",
"endTime": "23:59:00"
},
{
"dayOfWeek": "Saturday",
"startTime": "00:00:00",
"endTime": "23:59:00"
}
],
"loadTimes": []
}
Updated about 2 months ago