summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-04-05 22:10:21 +0200
committerChristian Grothoff <christian@grothoff.org>2021-04-05 22:10:21 +0200
commit456e6ff7b7b327eab17fb7f82f50e5a99d019f53 (patch)
treef855ba8d596d16c2ebec6aff3488f25cc17856c9 /core/api-merchant.rst
parent63d4b39f31d60c76126f654b3101347ade6f6f36 (diff)
downloaddocs-456e6ff7b7b327eab17fb7f82f50e5a99d019f53.tar.gz
docs-456e6ff7b7b327eab17fb7f82f50e5a99d019f53.tar.bz2
docs-456e6ff7b7b327eab17fb7f82f50e5a99d019f53.zip
clarify API
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst20
1 files changed, 9 insertions, 11 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 712bb58..4780302 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1617,17 +1617,15 @@ Creating orders
fulfillment_url?: string;
}
- The following fields can be specified if the order is inventory-based.
- In this case, the backend can compute the amounts from the prices given
- in the inventory. Note that if the frontend does give more details
- (portions of ``ContractTerms``), this will override those details
- (including total price) that would otherwise computed based on information
- from the inventory.
-
- .. ts:def:: ProductSpecification
-
- type ProductSpecification : (MinimalInventoryProduct | Product);
-
+ The following `ProductSpecification` can be provided if the parts of the
+ order are inventory-based, that is if the `PostOrderRequest` uses
+ ``inventory_products``. For such products, which must be in the backend's inventory,
+ the backend can automatically fill in the amount and other details about
+ the product that are known to it from its ``products`` table.
+ Note that the ``inventory_products`` will be appended to the
+ list of ``products`` that the frontend already put into the ``order``.
+ So if the frontend can sell additional non-inventory products together
+ with ``inventory_products``.
.. ts:def:: MinimalInventoryProduct