commit e54f385aa76a52c45dbf56a3282c8a080a6808df
parent d76314f0c3f7a2db17cb6546523aafa1bf45c52a
Author: Florian Dold <florian@dold.me>
Date: Wed, 18 Feb 2026 00:09:32 +0100
-syntax
Diffstat:
1 file changed, 39 insertions(+), 39 deletions(-)
diff --git a/taler-merchant-pos-terminal.rst b/taler-merchant-pos-terminal.rst
@@ -74,60 +74,60 @@ APIs and Data Formats
The GNU Taler merchant POS configuration is a single JSON file with the following structure.
- .. ts:def:: MerchantConfiguration
+.. ts:def:: MerchantConfiguration
- interface MerchantConfiguration {
- // Configuration for how to connect to the backend instance.
- config: BackendConfiguration;
+ interface MerchantConfiguration {
+ // Configuration for how to connect to the backend instance.
+ config: BackendConfiguration;
- // The available product categories
- categories: MerchantCategory[];
+ // The available product categories
+ categories: MerchantCategory[];
- // Products offered by the merchant (similar to `Product`).
- products: MerchantProduct[];
+ // Products offered by the merchant (similar to `Product`).
+ products: MerchantProduct[];
- // Map from labels to locations
- locations: { [label: string]: [location: Location], ... };
- }
+ // Map from labels to locations
+ locations: { [label: string]: [location: Location], ... };
+ }
The elements of the JSON file are defined as follows:
- .. ts:def:: BackendConfiguration
+.. ts:def:: BackendConfiguration
- interface BackendConfiguration {
- // The URL to the Taler Merchant Backend (including instance if applicable)
- base_url: string;
+ interface BackendConfiguration {
+ // The URL to the Taler Merchant Backend (including instance if applicable)
+ base_url: string;
- // The API key used for authentication
- api_key: string;
- }
+ // The API key used for authentication
+ api_key: string;
+ }
- .. ts:def:: MerchantProduct
+.. ts:def:: MerchantProduct
- interface MerchantProduct {
- // A merchant-internal unique identifier for the product
- product_id?: string;
+ interface MerchantProduct {
+ // A merchant-internal unique identifier for the product
+ product_id?: string;
- // Human-readable product description
- // that will be shown to the user and used in contract terms
- description: string;
+ // Human-readable product description
+ // that will be shown to the user and used in contract terms
+ description: string;
- // Map from IETF BCP 47 language tags to localized descriptions
- description_i18n?: { [lang_tag: string]: string };
+ // Map from IETF BCP 47 language tags to localized descriptions
+ description_i18n?: { [lang_tag: string]: string };
- // The price of the product
- price: Amount;
+ // The price of the product
+ price: Amount;
- // An optional base64-encoded product image
- image?: ImageDataUrl;
+ // An optional base64-encoded product image
+ image?: ImageDataUrl;
- // A list of category IDs this product belongs to.
- // Typically, a product only belongs to one category, but more than one is supported.
- categories: number[];
+ // A list of category IDs this product belongs to.
+ // Typically, a product only belongs to one category, but more than one is supported.
+ categories: number[];
- // Where to deliver this product. This may be an URL for online delivery
- // (i.e. 'http://example.com/download' or 'mailto:customer@example.com'),
- // or a location label defined inside the configuration's 'locations'.
- delivery_location: string;
- }
+ // Where to deliver this product. This may be an URL for online delivery
+ // (i.e. 'http://example.com/download' or 'mailto:customer@example.com'),
+ // or a location label defined inside the configuration's 'locations'.
+ delivery_location: string;
+ }