Sign in
admin-shipments

Update Shipment

Update shipment details. Validates status transitions.

patch/api/v1/admin/shipments/{shipment_id}

Path parameters

shipment_idstring uuid required

Request body

carrierstring nullable
tracking_numberstring nullable
tracking_urlstring nullable
statusstring nullable

New status (must be a valid ShipmentStatus transition)

estimated_deliverystring date nullable
actual_deliverystring date nullable
shipped_atstring date-time nullable
notesstring nullable

Response

Successful Response

idstring uuid required
project_idstring uuid required
carrierstring nullable
tracking_numberstring nullable
tracking_urlstring nullable
statusstring required
estimated_deliverystring date nullable
actual_deliverystring date nullable
shipped_atstring date-time nullable
notesstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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