--- title: "get events" method: GET path: "/freights/events/{shipmentId}" tags: ["Freight"] --- # get events `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` The list mirrors the timeline on the public tracking page of the shipment (same rows and titles), oldest first. **Event names** | Value | Description | |----------------------------------------|------------------------------------------------------------------------------------------| | needCarrier | Shipment was created ("Order received") - need to assign carrier. | | booked | Carrier was assigned to the shipment ("Order proceeded"). | | dispatched | The driver/vehicle has started for pickup location. | | arrivedAtPickup | The driver/vehicle has arrived at pickup location. | | pickupSuccessful | The shipment was loaded in the vehicle. | | pickupFailed | Pickup task failed. | | inRouteToDropoff | The driver/vehicle has started for dropoff location (out for delivery). | | arrivedAtDropoff | The driver/vehicle has arrived at dropoff location. | | dropoffSuccessful | The shipment was delivered successfully. | | dropoffFailed | Dropoff task failed. | | complete | The shipment is completed (delivered or disposed). | | returnInitiated | Return task was created. | | inRouteToReturn | The driver/vehicle has started for return location. | | arrivedAtReturn | The driver/vehicle has arrived at return location. | | returned | The shipment was returned successfully. | | canceled | The shipment was canceled. | | inRouteToWareHouse | The shipment is in route to a warehouse (cross-dock). | | arrivedAtWareHouse | The shipment arrived at a warehouse (cross-dock). | | departedFromWarehouse | The shipment departed from a warehouse (cross-dock). | | inTransit | In transit between stops / cross-dock facilities. | | receivedAtFacility | Received at a cross-dock facility. | | departedFacility | Departed a cross-dock facility (titled "Out for delivery" when it is the last one before the final dropoff). | | failedAtFacility | Processing at a cross-dock facility failed. | | requireAppointmentAtPickup | The pickup location requires an appointment. | | requireAppointmentAtDelivery | The delivery location requires an appointment. | | updateAppointmentTimeAtPickup | The pickup appointment info was updated (see details.appointmentInfo). | | updateAppointmentTimeAtDelivery | The delivery appointment info was updated (see details.appointmentInfo). | | appointmentConfirmationSentAtPickup | Pickup appointment confirmation was sent. | | appointmentConfirmationSentAtDelivery | Delivery appointment confirmation was sent. | | appointmentCanceledAtPickup | Pickup appointment was canceled. | | appointmentCanceledAtDelivery | Delivery appointment was canceled. | | appointmentCancellationSentAtPickup | Pickup appointment cancellation notice was sent. | | appointmentCancellationSentAtDelivery | Delivery appointment cancellation notice was sent. | | appointmentRequestUnansweredAtPickup | Pickup appointment request got no answer. | | appointmentRequestUnansweredAtDelivery | Delivery appointment request got no answer. | | appointmentRequestSendFailedAtPickup | Pickup appointment request could not be sent. | | appointmentRequestSendFailedAtDelivery | Delivery appointment request could not be sent. | ## Path parameters - `shipmentId` string, required ## Response `200` successful operation - GetEventsSuccess - `data` object[]: Tracking events, oldest first. - `message` string: Human readable description of the event. - `when` string, date-time: Time the event happened. - `createdWhen` string, date-time: Time the event was recorded. - `eventName` 'needCarrier' | 'booked' | 'dispatched' | 'arrivedAtPickup' | 'pickupSuccessful' | 'pickupFailed' | 'inRouteToDropoff' | 'arrivedAtDropoff' | 'dropoffSuccessful' | 'dropoffFailed' | 'complete' | 'returnInitiated' | 'inRouteToReturn' | 'arrivedAtReturn' | 'returned' | 'canceled' | 'inRouteToWareHouse' | 'arrivedAtWareHouse' | 'departedFromWarehouse' | 'inTransit' | 'receivedAtFacility' | 'departedFacility' | 'failedAtFacility' | 'requireAppointmentAtPickup' | 'requireAppointmentAtDelivery' | 'updateAppointmentTimeAtPickup' | 'updateAppointmentTimeAtDelivery' | 'appointmentConfirmationSentAtPickup' | 'appointmentConfirmationSentAtDelivery' | 'appointmentCanceledAtPickup' | 'appointmentCanceledAtDelivery' | 'appointmentCancellationSentAtPickup' | 'appointmentCancellationSentAtDelivery' | 'appointmentRequestUnansweredAtPickup' | 'appointmentRequestUnansweredAtDelivery' | 'appointmentRequestSendFailedAtPickup' | 'appointmentRequestSendFailedAtDelivery': Shipment status reached by the event, or an appointment event. - `details` object: Only present on appointment events. - `appointmentInfo` TimeWindow - `from` string, date-time, required: Starting time of the window in ISO format - `to` string, date-time, required: Ending time of the window in ISO format - `contactType` 'phone' | 'sms' | 'email' | 'link' | 'ob_phone': How the appointment was arranged. ## Other responses - `400`: Bad Request - the request payload is missing fields or contains invalid data. - `401`: Unauthorized - the apikey header is missing or does not match any active API key. - `403`: Forbidden - the customer account is suspended. The body carries `message` only, without `code`. - `429`: Too Many Requests - the quoting rate limit of the API key was exceeded (only POST /freights/quote, /freights/freight-quote and /freights/quote/multi-stops are rate limited; limits apply per UTC hour and per UTC day). The `Retry-After` header holds the number of seconds until the window resets. - `500`: Internal Server Error - an unknown error has occurred. --- [API](https://skmtc.dev/wearewarp/apis/warp-api-documentation.md) · [All operations](https://skmtc.dev/wearewarp/apis/warp-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/wearewarp/apis/warp-api-documentation/revisions/01526741bb48?raw)