Update a ShipmentTimelineEvent

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

shipmentTimelineEventId
required
string <uuid>
Request Body schema: application/json
required
actor
string or null <uuid>

ID of the User who took the action described in the event

created_at
string or null <date-time>
object (ShipmentTimelineEventCustomData)

Custom data for ShipmentTimelineEvents

description
string or null
event_sub_type
string or null
Enum: "AT_DELIVERY" "AT_LOCATION" "AT_PICKUP" "AT_STOP" "CANCELED" "DELAYED" "DELIVERED" "DELIVERED_EXCEPTION" "DELIVERY" "DELIVERY_APPOINTMENT" "DELIVERY_MISSED" "DEPARTED" "DEPARTED_STOP" "DEPARTURE" "DEPARTURE_MISSED" "DISPATCHED" "EN_ROUTE" "EXCEPTION" "HELD" "IN_TRANSIT" "INFO" "INTERLINE" "INTERLINE_DELIVERED" "INTERLINE_MISSED" "OUT_FOR_DELIVERY" "PICKED_UP" "PICKUP" "PICKUP_MISSED" "STOP_CANCELLED" "STOP_COMPLETED"
event_type
required
string
Enum: "AT_DELIVERY" "AT_PICKUP" "BOOKED" "CANCELLED" "CARRIER_MATCHED" "DELIVERED" "DETAILS_CHANGED" "DISPATCHED" "DRIVER_ASSIGNED" "ETA_CHANGED" "INFO" "LOCATION_UPDATED" "PICKED_UP" "TRACK_RECEIVED" "STOP_COMPLETED" "STOP_EVENT"
id
string or null <uuid>
occurred_at
string or null <date-time>
source
string or null
updated_at
string or null <date-time>
Responses
200

Successfully updated a ShipmentTimelineEvent

Response Schema: application/json
object (User)
created_at
string or null <date-time>
object (ShipmentTimelineEventCustomData)

Custom data for ShipmentTimelineEvents

description
string or null
event_sub_type
string or null
Enum: "AT_DELIVERY" "AT_LOCATION" "AT_PICKUP" "AT_STOP" "CANCELED" "DELAYED" "DELIVERED" "DELIVERED_EXCEPTION" "DELIVERY" "DELIVERY_APPOINTMENT" "DELIVERY_MISSED" "DEPARTED" "DEPARTED_STOP" "DEPARTURE" "DEPARTURE_MISSED" "DISPATCHED" "EN_ROUTE" "EXCEPTION" "HELD" "IN_TRANSIT" "INFO" "INTERLINE" "INTERLINE_DELIVERED" "INTERLINE_MISSED" "OUT_FOR_DELIVERY" "PICKED_UP" "PICKUP" "PICKUP_MISSED" "STOP_CANCELLED" "STOP_COMPLETED"
event_type
required
string
Enum: "AT_DELIVERY" "AT_PICKUP" "BOOKED" "CANCELLED" "CARRIER_MATCHED" "DELIVERED" "DETAILS_CHANGED" "DISPATCHED" "DRIVER_ASSIGNED" "ETA_CHANGED" "INFO" "LOCATION_UPDATED" "PICKED_UP" "TRACK_RECEIVED" "STOP_COMPLETED" "STOP_EVENT"
id
string or null <uuid>
occurred_at
string or null <date-time>
source
string or null
updated_at
string or null <date-time>
default

Default error response

put/shipments/{shipmentId}/timeline-events/{shipmentTimelineEventId}/
Request samples
application/json
{
  • "actor": "b4172a54-df0e-4918-8f0c-143e6e6d9830",
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": {
    },
  • "description": "string",
  • "event_sub_type": "AT_DELIVERY",
  • "event_type": "AT_DELIVERY",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occurred_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "actor": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": {
    },
  • "description": "string",
  • "event_sub_type": "AT_DELIVERY",
  • "event_type": "AT_DELIVERY",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occurred_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.