Mark As Planned
POST/api/inbound-shipments/:inbound_shipment/mark-as-planned
Transitions the shipment from Draft to Planned status. Planned is an optional intermediate state indicating the shipment is scheduled but has not yet shipped. Planned shipments do not reserve quantity against purchase order fulfillment.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The shipment must be in Draft status and must have at least one line.
Takes no request body.
Authentication: Requires Bearer token.
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.