diff options
author | Christian Grothoff <christian@grothoff.org> | 2024-03-18 23:08:59 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2024-03-18 23:08:59 +0100 |
commit | b924e099b65f9578d3012fe5969a4152c303e017 (patch) | |
tree | 589cd4e092f5549747c7f315e94345c47d6637f4 | |
parent | 621d7c1988bce77051c8230b1cbbc1dee21586c2 (diff) | |
download | docs-b924e099b65f9578d3012fe5969a4152c303e017.tar.gz docs-b924e099b65f9578d3012fe5969a4152c303e017.tar.bz2 docs-b924e099b65f9578d3012fe5969a4152c303e017.zip |
spec updates for protocol v12, fixes #7948
-rw-r--r-- | core/api-merchant.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index c1bbf058..efc2d5b9 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -123,7 +123,7 @@ such as the implemented version of the protocol and the currency used. .. http:get:: /config Return the protocol version and currency supported by this merchant backend. - This specification corresponds to ``current`` protocol being version **11**. + This specification corresponds to ``current`` protocol being version **12**. **Response:** @@ -1696,6 +1696,11 @@ Inspecting inventory This is used to return the list of all items in the inventory. + **Request:** + + :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**. + **Response:** :http:statuscode:`200 OK`: @@ -1719,6 +1724,8 @@ Inspecting inventory // Product identifier, as found in the product. product_id: string; + // ``product_serial_id`` of the product in the database. + product_serial: integer; } @@ -2066,9 +2073,11 @@ Inspecting orders :query paid: *Optional*. If set to yes, only return paid orders, if no only unpaid orders. Do not give (or use "all") to see all orders regardless of payment status. :query refunded: *Optional*. If set to yes, only return refunded orders, if no only unrefunded orders. Do not give (or use "all") to see all orders regardless of refund status. :query wired: *Optional*. If set to yes, only return wired orders, if no only orders with missing wire transfers. Do not give (or use "all") to see all orders regardless of wire transfer status. - :query delta: *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` and ``date_s`` are returned. Defaults to ``-20`` to return the last 20 entries (before ``start`` and/or ``date_s``). + :query delta: *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` and ``date_s`` are returned. Defaults to ``-20`` to return the last 20 entries (before ``start`` and/or ``date_s``). Deprecated in protocol **v12**. Use *limit* instead. + :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 date_s: *Optional.* Non-negative date in seconds after the UNIX Epoc, see ``delta`` for its interpretation. If not specified, we default to the oldest or most recent entry, depending on ``delta``. - :query start: *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. + :query start: *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. Deprecated in protocol **v12**. Use *offset* instead. + :query offset: *Optional*. Starting ``product_serial_id`` for an iteration. Since protocol **v12**. :query timeout_ms: *Optional*. Timeout in milliseconds to wait for additional orders if the answer would otherwise be negative (long polling). Only useful if delta is positive. Note that the merchant MAY still return a response that contains fewer than ``delta`` orders. :query session_id: *Optional*. Since protocol **v6**. Filters by session ID. :query fulfillment_url: *Optional*. Since protocol **v6**. Filters by fulfillment URL. |