Shipments
Generate invoice for shipment
Generate an invoice PDF for the shipment.
What happens
- Invoice PDF is generated
- Invoice document is attached to the shipment
- Shipment billing status changes to INVOICED
Prerequisites
- Shipment must be in READY_TO_INVOICE status
post/shipments/{id}/invoice/generate
Path parameters
idstring required
Resource ID (UUID) or client key
Query parameters
by'id' | 'key'
Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.
Response
Invoice generated