Release Order Hold
magento.unhold_order
ActionBusiness appsconnection required
Calls the Magento API with the connection's credentials.
Release a hold and return the sales order to its previous state.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Magento
- Secret shape
- the integration access token, or {"access_token": "…"}
- Config it needs
- base_url, store_code
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
order_id The order's entity id. | string | Yes | — | — | 1 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"order_id": "1"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
succeeded False only when Magento answered its own 'no' — the literal false, or the empty string on the capture route, which returns a string. It declined the call without raising an error. | boolean | — |
response Magento's raw answer, kept so a declined call is visible. | any | — |
order_id The order the call was sent for. | string | — |
{
"order_id": "",
"response": null,
"succeeded": false
}See Release Order Hold run in a workflow.
In a technical demo we add the Magento connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.