shipments
Logistics module · 5 operations
List shipment rows
GET/shipments
A shipment into or out of a venue. Returns a cursor page of shipment rows the caller may see. The default order is `ships_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a shipment
POST/shipments
A shipment into or out of a venue. Creates a shipment. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get a shipment
GET/shipments/{id}
A shipment into or out of a venue. Returns one shipment with its `ETag`. A shipment the caller may not see returns 404.
Update a shipment
PATCH/shipments/{id}
A shipment into or out of a venue. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Delete a shipment
DELETE/shipments/{id}
A shipment into or out of a venue. Soft-deletes the shipment: it moves to Trash and can be restored for its table's retention period.