Self-Service Order Status Change (Sandbox Only)

🧪 Sandbox only. This endpoint is available exclusively in non-production environments (sandbox). Calling it against the production base URL returns a 403 Forbidden. It exists so you can drive your own integration testing — cancelling, completing, requesting information, or requesting a file on a test order — without waiting on Swyft staff to do it manually.

You can self-service four transitions on the order you track: cancel it, complete it, open a rejection requesting more information, or open a rejection requesting an uploaded file.

Change order status

POST {baseUrl}/orders/{order_uuid}/simulate-processing
Authorization: Bearer {token}
Content-Type: application/json

{
  "action": "cancel"
}

Field	Type	Notes
order_uuid	string (path)	UUID of the order you are tracking.
action	string	One of cancel, complete, request_information, request_file.
reason	string	Required when action is request_information or request_file. Ignored otherwise. Max 1000 characters.

cancel

Sets the order's lifecycle to cancelled. The order's reported status becomes Cancelled. This endpoint has no self-service "reactivate" action — from the API's perspective the order stays cancelled until Swyft staff reactivate it — so calling cancel again on it returns a 422.

{ "action": "cancel" }

complete

Fast-forwards the order straight to the Completed processing stage, skipping the normal review → filed → approved pipeline. This is a testing convenience only — it does not represent an order that was actually reviewed or filed.

The order must currently be active — a cancelled (or otherwise non-active) order returns a 422 and must be reactivated by Swyft staff before it can be completed.

The order must also not currently be reporting Action Required — an order (or, for a bundle, any of its child orders) with an open rejection or pending questionnaire can't be completed until that's resolved; this also returns a 422.

{ "action": "complete" }

request_information

Opens a rejection on the order, the same mechanism Swyft staff use when they need something from the customer. The order's reported status becomes Action Required and the rejection is received on the Partner, to make it visible or communicated to the customer.

Cancelled orders and already-completed orders can't have a rejection opened — both return a 422.

{
  "action": "request_information",
  "reason": "Please confirm the registered agent's mailing address."
}

Resolve it exactly like any other rejection — see Respond to Order Rejections: the rejection this creates shows up under required_actions.rejections on the order, and POST {baseUrl}/orders/{order_uuid}/rejection closes it.

request_file

Opens a file request rejection on the order — the same kind Swyft staff open from the CRM when they need a document from the customer. The order's reported status becomes Action Required and the rejection is visible to the customer.

Unlike request_information, a file request doesn't need a manual rejection response: it resolves automatically the next time a document is uploaded to the order via Upload Order Documents — either by naming the rejection's id as rejection_id, or, if left unanswered, the oldest open file request resolves on the next plain upload. See Required files for the full upload/resolution mechanics.

Cancelled orders and already-completed orders can't have a rejection opened — both return a 422.

{
  "action": "request_file",
  "reason": "Signed operating agreement"
}

Success

{
  "data": {
    "message": "Order status updated successfully",
    "order_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "success": true
}

Every transition emits an order_status_change webhook for the order's new reported status, exactly as if the change had come from the CRM.

Errors and edge cases

• 403 Forbidden: You called this endpoint against a production base URL. It only works in Sandbox / non-production environments.
• 422 Validation: action is missing/unrecognized, reason is missing while action is request_information or request_file, the order is already in the target state (e.g. calling cancel on an already-cancelled order), complete is called on an order that isn't currently active (e.g. a cancelled order), complete is called on an order (or bundle with a child order) currently reporting Action Required, or request_information / request_file is called on a cancelled or already-completed order.
• 401 / 403: The order is not associated with your partner account.