Magento2 Search for Orders by Order #
This action is used to get order information from Magento2.
https://adobe-commerce.redoc.ly/2.4.7-admin/tag/orders#operation/GetV1Orders
We are using the following query parameters in this action:
- searchCriteria[filter_groups][0][filters][0][field] = increment_id
- searchCriteria[filter_groups][0][filters][0][value] = {Increment 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 |
Increment ID | String | The increment_id - this is typically the client's order number |
Outputs
Output | Type | Decription |
---|---|---|
Success | Boolean | True if managed to find an order; False if no orders found. |
Shipment Found | Boolean | True if shipment found from order, False if no Shipments found |
Order | Object | Raw order data |
Updated 3 months ago