Close Shipment
POST/api/inbound-shipments/:inbound_shipment/close
Closes an inbound shipment, finalizing it even if it has not been fully received. Any Draft, Planned, In Transit or Partially Received shipment can be closed; a closed shipment can be undone with Reopen Shipment.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Errors: 422 if the shipment is already Received, Closed or Cancelled.
Requires permission: purchase_orders.update
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.