List Invoice Comments
magento.list_invoice_comments
ActionBusiness appsconnection required
Calls the Magento API with the connection's credentials.
List the comments recorded against an invoice.
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 |
|---|---|---|---|---|---|
invoice_id The invoice's entity id. | string | Yes | — | — | 1 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"invoice_id": "1"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Magento returned them. | array | — |
count How many records are on this page. | number | — |
total_count How many records match the search across every page. | number | — |
search_criteria The criteria Magento echoed back for this page. | object | — |
has_more True when a further page of results is still waiting. | boolean | — |
{
"count": 0,
"has_more": false,
"items": [],
"search_criteria": {},
"total_count": 0
}See List Invoice Comments 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.