PATCH - Update Fixed Location

The Fixed Location PATCH comprises a JSON Object that ultimately allow users to PATCH a Fixed

Updating a Fixed Location

The PATCH fixed location endpoint allows the updating of a specific location attribute or the full location record, although a PUT is recommended in that situation.

The PATCH HTTP Endpoint for the Fixed Locations is listed below:

HTTP Verb: PATCH
URI: https://{domain}.locationmanagement.services.10-4.com/v1/fixedlocation
Authentication: Bearer Token

The PATCH fixed location endpoint has multiple parameter values that can be included in the object. At lease one of the following parameters must be provided:

fixedLocationType
fixedLocationName
streetAddressLine1
streetAddressLine2
cityName
stateCode
postalCode
countryCode
fixedLocationPoint
organizationReferenceCode
overrideDeliveryStatusFlag
geofenceRadiusInFeet
earlyShipmentStatusMinutes
onTimeShipmentStatusMinutes
inJeopardyShipmentStatusMinutes
lateShipmentStatusMinutes
hasEarlyStatusDefined
hasInJeopardyStatusDefined
dwellTimeMinutes
geofencePolygon
allowGeofenceRewind
dwellTimeBufferMinutes
operatingHours
loadTimes

Sample JSON:

[
{ "op": "replace", "path": "fixedLocationType", "value": 1 }
]

Success Response:

{
    "fixedLocationType": "Generic",
    "fixedLocationName": "PATCH",
    "streetAddressLine1": "4888 Pearl East Circle",
    "streetAddressLine2": null,
    "cityName": "Boulder",
    "stateCode": "CO",
    "postalCode": "80302",
    "countryCode": "US",
    "fixedLocationPoint": {
        "latitude": 40.0208,
        "longitude": -105.2394
    },
    "fixedLocationCode": "DTEST",
    "organizationReferenceCode": null,
    "overrideDeliveryStatusFlag": false,
    "geofenceRadiusInFeet": null,
    "earlyShipmentStatusMinutes": null,
    "onTimeShipmentStatusMinutes": null,
    "inJeopardyShipmentStatusMinutes": null,
    "lateShipmentStatusMinutes": null,
    "hasEarlyStatusDefined": false,
    "hasInJeopardyStatusDefined": false,
    "dwellTimeMinutes": 30,
    "isActiveFlag": true,
    "lastUpdatedDate": "2019-11-22T17:33:09+00:00",
    "geofencePolygon": {
        "type": "Feature",
        "geometry": {
            "type": "Polygon",
            "coordinates": [
                [
                    [
                        -105.24285,
                        40.02275
                    ],
                    [
                        -105.24395,
                        40.02087
                    ],
                    [
                        -105.24073,
                        40.01951
                    ],
                    [
                        -105.238,
                        40.01976
                    ],
                    [
                        -105.23754,
                        40.01946
                    ],
                    [
                        -105.23876,
                        40.02083
                    ],
                    [
                        -105.23809,
                        40.02187
                    ],
                    [
                        -105.23959,
                        40.02374
                    ],
                    [
                        -105.24179,
                        40.02424
                    ],
                    [
                        -105.24327,
                        40.02437
                    ],
                    [
                        -105.24285,
                        40.02275
                    ]
                ]
            ]
        },
        "properties": null
    },
    "allowGeofenceRewind": false,
    "dwellTimeBufferMinutes": 0,
    "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": [
        {
            "isLoadFlag": false,
            "pieceUnit": "Pallet",
            "loadTimeMinutes": 210
        },
        {
            "isLoadFlag": true,
            "pieceUnit": "Pallet",
            "loadTimeMinutes": 60
        },
        {
            "isLoadFlag": false,
            "pieceUnit": "Box",
            "loadTimeMinutes": 0
        },
        {
            "isLoadFlag": true,
            "pieceUnit": "Box",
            "loadTimeMinutes": 0
        },
        {
            "isLoadFlag": false,
            "pieceUnit": "Each",
            "loadTimeMinutes": 0
        },
        {
            "isLoadFlag": true,
            "pieceUnit": "Each",
            "loadTimeMinutes": 0
        }
    ]
}

Updated about 2 months ago