Search Orders
Search Orders. Request query parameters are similar to ListOrders with the addition of ?query= to allow free text search in certain fields.
Returns
An object with a “metadata” field containing pagination information, and an orders field containing a list of order objects.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
How many results to return at a time in the "orders" field of the response object. Defaults to 50.
How many results to skip. Used for pagination. Defaults to 0.
Payment status filter.
paid, unpaid partial, fulfilled, unfulfilled invoice, memo Selects a column to sort the orders. Defaults to sorting by the created_on date.
ordered_on, total, merchant_legal_dba Order to sort the column.
asc, desc Query string for order searching. This can be used alongside the previously defined filters and pagination parameters. This can be used to search for order/memo ID's, SKU(s), merchant company names, and vendor codes (only with admin token). All of these search parameters can be used simultaneously, just separate with whitespace.