commit ebeaff9ce40bf14600db143a7a90071a9fdf875d
parent 085eb41be9e855249ccdb9415f0fde3e6b784dcf
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Wed, 29 Oct 2025 12:19:38 +0100
API changes for v23: filtering of products by name, category or description, filtering of orders/contracts by summary
Diffstat:
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -2930,6 +2930,9 @@ Inspecting inventory
:query limit: *Optional*. At most return the given number of results. Negative for descending by row ID, positive for ascending by row ID. Default is ``20``. Since protocol **v12**.
:query offset: *Optional*. Starting ``product_serial_id`` for an iteration. Since protocol **v12**.
+ :query category_filter: *Optional*. Only returns products that are in a category where the category name contains the given text as a substring. Matching is case-insensitive. Since protocol **v23**.
+ :query name_filter: *Optional*. Only returns products where the product name contains the given text as a substring. Matching is case-insensitive. Since protocol **v23**.
+ :query description_filter: *Optional*. Only returns products where the product description contains the given text as a substring. Matching is case-insensitive. Since protocol **v23**.
**Response:**
@@ -2959,7 +2962,6 @@ Inspecting inventory
// ``product_serial_id`` of the product in the database.
product_serial: Integer;
- // TODO: also return description/description_i18n here?
}
@@ -3642,6 +3644,7 @@ Inspecting orders
:query timeout_ms: *Optional*. Timeout in milliseconds to wait for additional orders if the answer would otherwise be negative (long polling). Only useful if ``limit`` is positive. Note that the merchant MAY still return a response that contains fewer than ``limit`` orders.
:query session_id: *Optional*. Since protocol **v6**. Filters by session ID.
:query fulfillment_url: *Optional*. Since protocol **v6**. Filters by fulfillment URL.
+ :query summary_filter: *Optional*. Only returns orders where the summary contains the given text as a substring. Matching is case-insensitive. Since protocol **v23**.
**Response:**