Magento2 Search for Orders by Order #

This action is used to get order information from Magento2.

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}


In order to use the action in your flow you need to provide it with the following inputs:

Magento HostStringMagento Host / Domain Name
Access TokenSensitiveStringThe access token required to execute API calls with Magento2
Increment IDStringThe increment_id - this is typically the client's order number


SuccessBooleanTrue if managed to find an order; False if no orders found.
OrderObjectRaw order data