Receive Shipment
POST/api/inbound-shipments/:inbound_shipment/receive
Records receipt of items for the specified shipment lines and updates inventory. Can be called multiple times for partial receiving.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Fields:
- received_at (required): Date/time of receipt
- warehouse_id (optional): Override destination warehouse for this receipt
- receipt_lines (required): Array of lines to receive — each requires inbound_shipment_line_id and quantity (min 0.0001)
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 — 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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.