Retrieve List of Orders

1-based page number to return. Defaults to 1.

Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.

Sort direction by internal order id: DESC (newest first) or ASC (oldest first).

Filter to orders whose order_key matches any value in this list.

Filter to orders whose order_number matches any value in this list.

Searches orders the same way as the search box in the ShipMonk app. Combined with the other filters by AND.

Matches orders by these searched fields:

• Order number
• Reference number
• Customer order number
• PO number
• Other order references, such as release number or job number

How matching works

Each searched field is split into words at spaces and at these characters: # - , :

An order matches when any word in its searched fields starts or ends with the search text. A leading # in the search text is ignored, so #1001 returns the same results as 1001.

Example

Searching 1001 finds orders with these field values:

Other matched fields

The search also matches tracking numbers, order key, customer name, zip code, customer email and address, serial numbers, freight BOL, load, carrier and shipment tracking numbers, and RMA or return order numbers.

Whitespace

Leading and trailing whitespace is trimmed. A search containing only whitespace is treated as if it was not sent.

Filter to orders of these store IDs. You can find a store ID in the ShipMonk app under Account Settings > Stores > Store ID, and every order in the response contains its store_id. IDs of stores outside your account are ignored.

Filter by current order status (see PublicApiOrderStatus enum); omit to return all statuses.

Filter by order type (see OrderType enum); omit to return all types.

Lower bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or after this time.

Upper bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or before this time.

Lower bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or after this time.

Upper bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or before this time.