Skip to main content
POST
Simulate order type

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

id
string
required

Unique identifier for the order type that generated by system. Example: 6710a2f4c1d2e3f4a5b6c7d8

Body

application/json
order
object
required

The test order: hubId (optional, must be a hub of your organization), values (checked against the draft fields) and optional externalRef (max 200 characters).

draft
object

Optional unsaved draft (fields, statuses, configuration, orderSteps). When omitted, the stored draft is used (never the published version).

trigger
object

For an onTaskFinished trigger: answers, the finished task's answers the run starts from.

answers
object

Answers per createTask step id, used to complete the simulated task. One object for every row, or { "rows": [ ... ] } per row. A step with no answer waits.

webhooks
object

Outcome per callWebhook step id: { "outcome": "success" | "failed", "httpStatus"?, "response"? }. A step with no outcome waits.

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

Result of the simulated run.