Book Order
POST/api/shippit/instances/:integration_instance/orders/:order/book
Books a Shippit order with its allocated courier via Shippit's POST /book (sends it to the carrier and generates the manifest). Runs as a background job; the response returns the tracked job log id, which you can poll for progress.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Shippit only books an order once it has labelled it (courier allocated), usually a few minutes after the order is placed — an earlier attempt fails the job with Shippit's reason. With Auto-book orders on, SKU.io queues this booking automatically.
No request body is required. Returns 404 for an order of another instance and 422 when the order is not bookable (already booked, not yet sent to Shippit, or past order_placed) — see is_bookable on the order.
Authentication: requires a Bearer token.
Requires the fulfillment_orders.ship 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
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
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.