Magento(SOAP v1) Search for Order by Increment ID V2

Looks up a specific order in a Magento store by its increment ID (the order number the customer sees), returning the full order details along with any shipments. Use it when the customer or flow already has the order number.

What it does

  • Finds the order that matches the given Magento increment ID.
  • Returns the full order information, including line items.
  • Adds any shipment records and shipment details linked to the order.
  • Reports whether an order was found through the Success flag.

Inputs

NameTypeDescription
HostStringMagento host
UsernameString (sensitive)Magento username
API KeyString (sensitive)Magento API Key
Increment IDStringMagento increment id to search by

Outputs

NameTypeDescription
SuccessBooleanWhether order was found or not
OrderObjectOrder

Notes

  • The increment ID is the human-readable order number, not Magento's internal order ID.
  • This action uses Magento's legacy SOAP v1 API and requires SOAP API access to be enabled on the store.