Search Orders
search_ordersSearch orders by date range, customer email, order number, or product SKU. Returns a summary of matching orders with profit per order. Hard-capped at 100 results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sku | No | Product SKU to match against any line item on the order. | |
| limit | No | Maximum number of orders to return (default 20, hard-capped at 100). | |
| end_date | No | End of the date range, in YYYY-MM-DD format, resolved as the end of that day in the tenant's timezone. | |
| start_date | No | Start of the date range, in YYYY-MM-DD format, resolved as the start of that day in the tenant's timezone. At least one of start_date, end_date, customer_email, order_number, or sku is required. | |
| order_number | No | The store's own order number, with or without a leading '#', not the internal MerchantFlow order id. | |
| customer_email | No | Customer email to search for; it is hashed before querying so no plaintext email is used as a lookup key, and the customer_email field on each returned order is redacted. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _meta | No | ||
| count | No | ||
| orders | No | ||
| filters | No | ||
| _message | No | ||
| currency | No | ||
| _truncated | No | ||
| _tenant_context | No |