Cancel Dropship Order
POST/api/portal/dropship/orders/:order/cancel
Cancels a dropship order while the warehouse has not started on it — nothing has been sent to a warehouse or 3PL and no packing slip has been printed. Check can_cancel on the order first. Uses the order's id (not your order number). No body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
If the warehouse has already started, the cancel is refused with 422 already_processing, and the request is passed to your account manager, who may still be able to stop it.
Auth: a portal session bearer token, or a portal API key (pfk_…) with the dropship:write scope, sent as Authorization: Bearer. A Viewer-role buyer (or a key owned by one) is refused with 403 viewer_read_only. Requires an enabled dropship program; 60 requests a minute.
Returns the updated order with status: cancelled.
Errors: 404 not_found when the id is not one of your dropship orders; 422 already_cancelled or already_processing.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthorized
Response Headers
Forbidden
Response Headers
Not Found
Response Headers
Unprocessable Content
Response Headers
Too Many Requests