Get Shipment Prefill (From Invoice)
GET/api/purchase-invoices/:purchaseInvoice/shipment-prefill
Build the prefill payload used by the Create Inbound Shipment from Invoice form.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns header info (supplier, PO, invoice number, default destination warehouse from PO), one row per non-fully-shipped invoice line with quantity_remaining_to_ship pre-filled, and soft warnings (e.g. fully-shipped lines).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.