Update the tracking number of a shipment and create tracking events.

The initial request for a shipment must contain the tracking_number. All other updates for the shipment don't need to have it (unless it needs to be changed).

For primary_status values, refer to the BODY PARAMS (below) -> events -> ADD OBJECT -> primary_status.

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"
    }
  ]
}

Note: This endpoint is only available to eFulfillment clients who have shipments fulfilled at one of Easyship's integrated warehouses.

Language
Authentication
Bearer
token
Click Try It! to start a request and see the response here!