Corgi BankDocumentation
OpenAPI

Read a shipment, sealed manifest and progress

GET/cash-operations/shipments/{shipment}

Path parameters

shipmentstringRequired

Returns

200 OK

actorstringRequired
amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

carrier_idstringRequired
created_atstring · date-timeRequired
exceptionstringOptional
from_unit_idstringOptional
idstringRequired
kindstringRequired
manifestobject or nullOptional
7 child attributes
actorstringRequired
amountintegerRequired
created_atstring · date-timeRequired
denominationsobjectRequired
idstringRequired
seal_numbersarray of stringsRequired
shipment_idstringRequired
movement_idstringOptional
order_idstringRequired
progressarray of objectsRequired
5 child attributes
actorstringRequired
carrier_referencestringRequired
evidencestringRequired
recorded_atstring · date-timeRequired
statusstringRequired

Scheduled, picked_up, in_transit, delivered, exception

statusstringRequired
to_unit_idstringOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close