POST - Add Shipment Milestone

The shipment milestone API is intended to allow users to post a milestone to an LTL or Parcel shipment. This allows for more event based updates to be posted to these shipment types as those are the relevant types we see most on these shipment types. This does not change the other allowed updates from being posted to these shipment types, but rather allows these updates in addition to traditional shipment tracking updates.

The POST HTTP Endpoint for milestones is listed below:

HTTP Verb: POST
URI: /v2/shipments/{{Shipment Ten Four License Plate or Freight Provider Reference Number}}/milestone
Authentication: Validation Through Request Parameters

This endpoint supports both optional and required parameters when posting a shipment milestone. These parameters are listed below:

Name	Type	Description
EventDate - Required	Date	This is an event date for the time that the milestone being posted would have happened. This needs to be current or past, it cannot be in the future.
EstimatedTimeOfArrival - Optional	Date	This is the ETA for the shipment that the milestone is being posted for. This is the ETA to the destination on the shipment and not intermediate stops.
MilestoneType - Required	Enumeration	This is the type of milestone being sent in. See the list of Enumeration for further details.
ShipmentMilestoneLocation - Required	String	Only city and state is required, all other fields are optional. See sample post for other fields.
ShipmentReferences - Required	String	This is the shipment identifiers, the XID and the MC, SCAC, or DOT depending on which is on the shipment.

Sample POST:

{
       "EventDate" : "2020-10-07 10:15:00 -07:00",
        "EstimatedTimeOfArrival" : "2020-10-09 14:00:00-06:00",
        "MilestoneType" : "PickedUp",
        "EventDetail" : "Picked up by carrier",
        "ShipmentMilestoneLocation": {
        	 "streetAddressLine1": null,
             "streetAddressLine2": null,
             "CityName": "Boulder",
             "StateCode": "CO",
             "postalCode": null,
             "CountryCode" : null,
             "latitude": null,
             "longitude": null
        },
        "ShipmentReferences" : 
            {
                  "FreightHaulerProviderXID" : "REG_XID_5",
                   "CarrierMC": "214366"
            }
}