Auto-Pack Shipment
POST/api/spscommerce/fulfillments/:salesOrderFulfillment/packing/auto-pack
Build and save a packing plan automatically. mode=case_pack fills full cartons of each product's case quantity, puts each remainder in its own carton and products with no case quantity in one shared carton; mode=single_carton packs everything into one carton. Carton weights are estimated from product weights. Returns the new packing and any warnings.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token. Available for shipments of SPS Commerce EDI orders; other shipments return 404. Requires the sales_orders.update permission.
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.
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.