From 1f9b0b842f0c692b4560a12dbf68c318256db0ef Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Mon, 1 Aug 2022 13:06:01 +0200 Subject: [PATCH] Docs: Clarify information on search= parameter for orders --- doc/api/resources/orders.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/resources/orders.rst b/doc/api/resources/orders.rst index 1282dc3eca..fcfd2b98dd 100644 --- a/doc/api/resources/orders.rst +++ b/doc/api/resources/orders.rst @@ -428,7 +428,7 @@ List of all orders ``last_modified``, and ``status``. Default: ``datetime`` :query string code: Only return orders that match the given order code :query string status: Only return orders in the given order status (see above) - :query string search: Only return orders matching a given search query + :query string search: Only return orders matching a given search query (matching for names, email addresses, and company names) :query integer item: Only return orders with a position that contains this item ID. *Warning:* Result will also include orders if they contain mixed items, and it will even return orders where the item is only contained in a canceled position. :query integer variation: Only return orders with a position that contains this variation ID. *Warning:* Result will also include orders if they contain mixed items and variations, and it will even return orders where the variation is only contained in a canceled position. :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``