Magento2 Search for Invoice by Order ID
Search for Invoice by Order ID - mainly used to find invoice id for refunds
This action is used to get invoice information from Magento2.
https://adobe-commerce.redoc.ly/2.4.7-admin/tag/invoices#operation/GetV1Invoices
We are using the following query parameters in this action:
- searchCriteria[0][0][field] = order_id
- searchCriteria[0][0][value] = {Order ID}
Inputs
In order to use the action in your flow you need to provide it with the following inputs:
| Input | Type | Description |
|---|---|---|
| Magento Host | String | Magento Host / Domain Name |
| Access Token | SensitiveString | The access token required to execute API calls with Magento2 |
| Order ID | String | The order_id from Magento data (note this may be different from the client's order number which is typically stored as 'increment_id' in Magento) |
Outputs
| Output | Type | Decription |
|---|---|---|
| Success | Boolean | True if managed to find an invoice; False if no invoices found. |
| Invoice Data | Object | Raw data |
| Items List | Object | List of items found in invoice |
| Invoice ID | String | Invoice ID (to be used in Magento2 Invoice Refund action) |
Updated 8 months ago
Did this page help you?