Tracking Updates

Update the shipment tracking number and create tracking events.

Required authorization scopes: public.shipment:write, public.efulfillment:write

This endpoint is only available to eFulfillment clients with shipments fulfilled at one of Easyship's integrated warehouses.

You will need to specify tracking_number for initial request for a shipment. Further updates of a shipment with the same easyship_shipment_id don't need to have the tracking number unless you change it.

For events, specify the primary_status field from the list:

• InTransit
• OutForDelivery
• AttemptFail
• Delivered
• Exception

Example request for an initial setup of a shipment

{
  "easyship_shipment_id": "ESHK10017799",
  "tracking_number": "ABCD1234",
  "events": [
    {
      "primary_status": "InTransit"
    }
  ]
}

Example request for a shipment status update

This example has optional event_time and event_time_zone.

{
  "easyship_shipment_id": "ESHK10017799",
  "events": [
    {
      "primary_status": "OutForDelivery",
      "event_time": "2020-04-29T03:38:00",
      "event_time_zone": "-04:00"
    }
  ]
}

Example request for a complete update

{
  "easyship_shipment_id": "ESHK10017799",
  "events": [
    {
      "primary_status": "OutForDelivery",
      "location": "Brooklyn, NY",
      "city": "Brooklyn",
      "country_alpha2": "US",
      "state": "NY",
      "zip": "11201",
      "handler": "UPS",
      "message": "On UPS vehicle for delivery",
      "event_time": "2020-04-29T03:38:00",
      "event_time_zone": "-04:00"
    }
  ]
}