Freight

get events

The list mirrors the timeline on the public tracking page of the shipment (same rows and titles), oldest first.

Event names

ValueDescription
needCarrierShipment was created ("Order received") - need to assign carrier.
bookedCarrier was assigned to the shipment ("Order proceeded").
dispatchedThe driver/vehicle has started for pickup location.
arrivedAtPickupThe driver/vehicle has arrived at pickup location.
pickupSuccessfulThe shipment was loaded in the vehicle.
pickupFailedPickup task failed.
inRouteToDropoffThe driver/vehicle has started for dropoff location (out for delivery).
arrivedAtDropoffThe driver/vehicle has arrived at dropoff location.
dropoffSuccessfulThe shipment was delivered successfully.
dropoffFailedDropoff task failed.
completeThe shipment is completed (delivered or disposed).
returnInitiatedReturn task was created.
inRouteToReturnThe driver/vehicle has started for return location.
arrivedAtReturnThe driver/vehicle has arrived at return location.
returnedThe shipment was returned successfully.
canceledThe shipment was canceled.
inRouteToWareHouseThe shipment is in route to a warehouse (cross-dock).
arrivedAtWareHouseThe shipment arrived at a warehouse (cross-dock).
departedFromWarehouseThe shipment departed from a warehouse (cross-dock).
inTransitIn transit between stops / cross-dock facilities.
receivedAtFacilityReceived at a cross-dock facility.
departedFacilityDeparted a cross-dock facility (titled "Out for delivery" when it is the last one before the final dropoff).
failedAtFacilityProcessing at a cross-dock facility failed.
requireAppointmentAtPickupThe pickup location requires an appointment.
requireAppointmentAtDeliveryThe delivery location requires an appointment.
updateAppointmentTimeAtPickupThe pickup appointment info was updated (see details.appointmentInfo).
updateAppointmentTimeAtDeliveryThe delivery appointment info was updated (see details.appointmentInfo).
appointmentConfirmationSentAtPickupPickup appointment confirmation was sent.
appointmentConfirmationSentAtDeliveryDelivery appointment confirmation was sent.
appointmentCanceledAtPickupPickup appointment was canceled.
appointmentCanceledAtDeliveryDelivery appointment was canceled.
appointmentCancellationSentAtPickupPickup appointment cancellation notice was sent.
appointmentCancellationSentAtDeliveryDelivery appointment cancellation notice was sent.
appointmentRequestUnansweredAtPickupPickup appointment request got no answer.
appointmentRequestUnansweredAtDeliveryDelivery appointment request got no answer.
appointmentRequestSendFailedAtPickupPickup appointment request could not be sent.
appointmentRequestSendFailedAtDeliveryDelivery appointment request could not be sent.
get/freights/events/{shipmentId}

Request

  • Base URL: https://stg.wearewarp.com/api/v1
  • URL: https://stg.wearewarp.com/api/v1/freights/events/{shipmentId}
  • Auth: API key in header apikey

Path parameters

shipmentIdstring required
Example:01H3W51F7FEC42MFZAXJQTG4CY

Id of the shipment. The shipment code (e.g. S-00524-2635) is accepted as well.

Response

successful operation

Example response

{
  "data": [
    {
      "message": "The shipment was created",
      "when": "2023-07-09T23:23:24.989Z",
      "createdWhen": "2023-07-09T23:23:24.989Z",
      "eventName": "needCarrier"
    },
    {
      "message": "The pickup location requires Appointment.",
      "when": "2023-07-09T23:23:24.992Z",
      "createdWhen": "2023-07-09T23:23:24.992Z",
      "eventName": "requireAppointmentAtPickup"
    },
    {
      "message": "The delivery location requires Appointment.",
      "when": "2023-07-09T23:23:24.992Z",
      "createdWhen": "2023-07-09T23:23:24.992Z",
      "eventName": "requireAppointmentAtDelivery"
    },
    {
      "message": "The pickup appointment Info was updated.",
      "when": "2023-07-09T23:23:37.695Z",
      "createdWhen": "2023-07-09T23:23:37.695Z",
      "eventName": "updateAppointmentTimeAtPickup",
      "details": {
        "appointmentInfo": {
          "from": "2023-07-10T11:04:33.000Z",
          "to": "2023-07-10T12:23:35.000Z"
        }
      }
    },
    {
      "message": "The delivery appointment Info was updated.",
      "when": "2023-07-09T23:23:51.202Z",
      "createdWhen": "2023-07-09T23:23:51.202Z",
      "eventName": "updateAppointmentTimeAtDelivery",
      "details": {
        "appointmentInfo": {
          "from": "2023-07-13T08:23:45.000Z",
          "to": "2023-07-13T10:23:49.000Z"
        }
      }
    },
    {
      "message": "In Route to Pickup location",
      "when": "2023-07-09T23:33:45.790Z",
      "createdWhen": "2023-07-09T23:33:45.790Z",
      "eventName": "dispatched"
    },
    {
      "message": "Driver arrived at pickup location",
      "when": "2023-07-10T00:22:33.918Z",
      "createdWhen": "2023-07-10T00:22:33.918Z",
      "eventName": "arrivedAtPickup"
    },
    {
      "message": "Pickup successful",
      "when": "2023-07-10T00:22:42.491Z",
      "createdWhen": "2023-07-10T00:22:42.491Z",
      "eventName": "pickupSuccessful"
    },
    {
      "message": "Pickup Appointment Confirmation Sent",
      "when": "2023-07-10T00:30:00.000Z",
      "createdWhen": "2023-07-10T00:30:00.000Z",
      "eventName": "appointmentConfirmationSentAtPickup",
      "details": {
        "appointmentInfo": {
          "from": "2023-07-10T11:04:33.000Z",
          "to": "2023-07-10T12:23:35.000Z"
        }
      }
    },
    {
      "message": "Delivery Appointment Canceled",
      "when": "2023-07-10T03:10:00.000Z",
      "createdWhen": "2023-07-10T03:10:00.000Z",
      "eventName": "appointmentCanceledAtDelivery"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.