Brightree integration

Cancel Sales Order POD

Perform Cancel Sales Order POD through Brightree.

View as Markdown

brightree_cancel_sales_order_pod

irreversiblebrightree

Inputs

sales_order_key
expressionrequired
Sales Order Key
Required literal value or workflow expression.
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
cancelledCancelled
already_cancelledAlready Cancelled
dry_runDry Run
sales_order_keySales Order Key
previous_statusPrevious Status
current_statusCurrent Status
messageMessage
errorError
error_messageError Message

Output schema completeness: best_effort_declared

Safety

External effect: irreversible
Confirmation recommended: Yes
Retry safe: No
Dry run supported: Yes

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "sales_order_key"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "sales_order_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "cancelled": {},
    "error_message": {},
    "current_status": {},
    "previous_status": {},
    "sales_order_key": {},
    "already_cancelled": {}
  },
  "additionalProperties": true
}

View all Brightree actions