v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Order

Search for orders

Search orders by ID or customer email in the specified store. Requires the stores.orders.view permission.

get/stores/{storeId}/orders/search/{query}

Path parameters

storeIdstring uuid required

The ID of the store to search orders in.

querystring required

The search term (order ID or customer email).

Query parameters

dateFromstring date-time

Gets or sets the starting date for filtering orders.

dateTostring date-time

Represents the end date/time filter for an order.

statusstring

Gets or sets the status of the order for filtering.

gatewaystring

Gets or sets the gateway of the order for filtering.

emailstring

Represents an email address to be used as a filter criteria.

discordstring

Filter orders by Discord user ID or username.

Filtersstring
Sortsstring
Pageinteger
PageSizeinteger

Response

The object was successfully returned.

successboolean required

Indicates whether the operation was successful

pagesinteger required

The total number of pages available in the paginated response.