List shipments
finale_list_shipmentsRead-only
List shipments (sales shipments, purchase receipts, transfers): shipmentId, type, status (for example SHIPMENT_INPUT, SHIPMENT_PACKED, SHIPMENT_SHIPPED), order, origin/destination, dates, tracking code. GET /{account}/api/shipment/.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum rows to return, 1-1000 (default 100). | |
| fields | No | Fields to return per row (default: a compact useful set). | |
| status | No | Exact shipment status, e.g. SHIPMENT_SHIPPED. | |
| updated_since | No | Only records last updated on or after this UTC time. Finale allows a range of at most 30 days (updated_until defaults to now). | |
| updated_until | No | Only records last updated on or before this UTC time (needs updated_since). |