Sign in

v1

latestOpenAPI 3.0.12026-08-04671711.0 MB
Shipment Events

Create shipment event

When moving the load always start the flow with the shipment:en-route-to-pickup event.

post/api/v2/shipments/{shipment_id}/events

Path parameters

shipment_idstring uuid required

Shipment UUID

Request body

type'shipment:en-route-to-pickup' | 'shipment:check-in-pickup' | 'shipment:check-out-pickup' | 'shipment:check-in-delivery' | 'shipment:check-out-delivery' | 'shipment:incident' | 'shipment:carrier-updated' required

Event type

event_datestring date-time

The date and time of the event (if not informed, current date is used)

stop_indexinteger

Corresponds to the number of the stop, being 0-based for pickup

Response

Event successfully created