Record pickup, transit, delivery or exception
POST
/cash-operations/shipments/{shipment}/progressPath parameters
shipmentstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
carrier_referencestringRequiredevidencestringRequiredstatusstringRequiredPicked_up, in_transit, delivered, exception
Returns
200 OK
actorstringRequiredamountintegerRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
carrier_idstringRequiredcreated_atstring · date-timeRequiredexceptionstringOptionalfrom_unit_idstringOptionalidstringRequiredkindstringRequiredmanifestobject or nullOptional7 child attributes
actorstringRequiredamountintegerRequiredcreated_atstring · date-timeRequireddenominationsobjectRequiredidstringRequiredseal_numbersarray of stringsRequiredshipment_idstringRequiredmovement_idstringOptionalorder_idstringRequiredprogressarray of objectsRequired5 child attributes
actorstringRequiredcarrier_referencestringRequiredevidencestringRequiredrecorded_atstring · date-timeRequiredstatusstringRequiredScheduled, picked_up, in_transit, delivered, exception
statusstringRequiredto_unit_idstringOptionalErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503