Get Invoice

magento.get_invoice
ActionBusiness appsconnection required

Calls the Magento API with the connection's credentials.

Retrieve one invoice by its entity id, including its line items.

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.

FieldTypeRequiredDefaultConstraintsExample
invoice_id
The invoice's entity id.
stringYes——1

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "invoice_id": "1"
}

Output

One shape.

result

FieldTypeExample
entity_id
The invoice's entity id.
number—
increment_id
The human-readable invoice number.
string—
order_id
The order this invoice belongs to.
number—
state
The invoice state: 1 open, 2 paid, 3 cancelled.
number—
grand_total
The invoiced total in the order's currency.
number—
created_at
When the invoice was created.
string—
items
The invoiced line items.
array—
{
  "created_at": "",
  "entity_id": 0,
  "grand_total": 0,
  "increment_id": "",
  "items": [],
  "order_id": 0,
  "state": 0
}

See Get Invoice 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.