taler-docs

get-templates-TEMPLATE_ID.rst (7229B)

---

 .. http:get:: [/instances/$INSTANCE]/templates/$TEMPLATE_ID
 
   This is used to obtain information about a specific template by wallets
   before they ask the user to fill in details.
   This endpoint is available since protocol **v11**.
 
   **Response:**
 
   :http:statuscode:`200 OK`:
     The backend has successfully returned the detailed information about a specific template.
     Returns a `WalletTemplateDetailsResponse`.
   :http:statuscode:`401 Unauthorized`:
     The request is unauthorized.
   :http:statuscode:`404 Not found`:
     The instance or template(ID) is unknown to the backend.
     Returned with ``TALER_EC_MERCHANT_GENERIC_TEMPLATE_UNKNOWN``.
   :http:statuscode:`500 Internal Server Error`:
     The server experienced an internal failure.
     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED`` or
     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE``.
 
   **Details:**
 
   For ``inventory-cart`` templates the backend augments the returned
   ``template_contract`` with ``inventory_payload`` containing products,
   categories, and units. The payload is filtered by the template's
   ``selected_all``, ``selected_categories``, and ``selected_products`` settings.
 
   .. ts:def:: WalletTemplateDetailsResponse
 
     interface WalletTemplateDetailsResponse {
 
       // Hard-coded information about the contract terms
       // for this template.
       template_contract: TemplateContractDetails;
 
       // Key-value pairs matching a subset of the
       // fields from ``template_contract`` that are
       // user-editable defaults for this template.
       // Since protocol **v13**.
       editable_defaults?: Object;
 
       // Required currency for payments.  Useful if no
       // amount is specified in the ``template_contract``
       // but the user should be required to pay in a
       // particular currency anyway.  Merchant backends
       // may reject requests if the ``template_contract``
       // or ``editable_defaults`` do
       // specify an amount in a different currency.
       // This parameter is optional; since protocol **v34** it is
       // returned whenever the ``template_contract`` specifies a
       // ``currency``.
       // Since protocol **v13**.
       required_currency?: string;
 
       // Information about the merchant instance that will create
       // the order.  The final contract terms remain authoritative,
       // as the instance configuration may change between this
       // request and order creation.
       // Since protocol **v41**.
       merchant: Merchant;
 
       // Public key currently used by the merchant instance.
       // The final contract terms remain authoritative, as the key
       // may change between this request and order creation.
       // Since protocol **v41**.
       merchant_pub: EddsaPublicKey;
 
       // Trusted exchanges that are currently known to be compatible
       // with at least one active payment target of the merchant instance.
       // This list is advisory and may be empty or incomplete when an
       // exchange's keys cannot be obtained in time.  The backend may
       // omit this field entirely when it does not perform exchange
       // discovery, for example to avoid its latency or resource cost.
       // Since protocol **v41**.
       exchange_candidates?: TemplateExchangeCandidate[];
     }
 
   .. ts:def:: TemplateExchangeCandidate
 
     // An exchange that may be usable for an order instantiated from
     // this template.  Whether it is present in the final contract also
     // depends on the selected amount and payment target, legal limits,
     // KYC state, and the configuration at order creation time.
     interface TemplateExchangeCandidate {
 
       // Base URL of the exchange REST API.
       base_url: WebURL;
 
       // Currency for which the merchant trusts this exchange.
       currency: string;
 
       // Offline master public key of the exchange.
       master_pub: EddsaPublicKey;
 
       // Active merchant wire methods that the exchange is currently
       // known to support for this instance.
       wire_methods: string[];
     }
 
   .. ts:def:: InventoryPayload
 
     interface InventoryPayload {
       // Inventory products available for selection.
       // Since protocol **v25**.
       products: InventoryPayloadProduct[];
 
       // Categories referenced by the payload products.
       // Since protocol **v25**.
       categories: InventoryPayloadCategory[];
 
       // Custom units referenced by the payload products.
       // Since protocol **v25**.
       units: InventoryPayloadUnit[];
     }
 
   .. ts:def:: InventoryPayloadProduct
 
     interface InventoryPayloadProduct {
       // Product identifier.
       // Since protocol **v25**.
       product_id: Slug;
 
       // Human-readable product name.
       // Since protocol **v25**.
       product_name: string;
 
       // Human-readable product description.
       // Since protocol **v25**.
       description: string;
 
       // Localized product descriptions.
       // Since protocol **v25**.
       description_i18n?: { [lang_tag: string]: string };
 
       // Unit identifier for the product.
       // Since protocol **v25**.
       unit: Slug;
 
       // Price tiers for the product.
       // Since protocol **v25**.
       unit_prices: Amount[];
 
       // Whether fractional quantities are allowed for this unit.
       // Since protocol **v25**.
       unit_allow_fraction: boolean;
 
       // Maximum fractional precision (0-6) enforced for this unit.
       // Since protocol **v25**.
       unit_precision_level: Integer;
 
       // Remaining stock available for selection.
       // Since protocol **v25**.
       remaining_stock: DecimalQuantity;
 
       // Category identifiers associated with this product.
       // Since protocol **v25**.
       categories: Integer[];
 
       // Taxes applied to the product.
       // Since protocol **v25**.
       taxes?: Tax[];
 
       // Hash of the product image (if any).
       // Since protocol **v25**.
       image_hash?: string;
     }
 
   .. ts:def:: InventoryPayloadCategory
 
     interface InventoryPayloadCategory {
       // Category identifier.
       // Since protocol **v25**.
       category_id: Integer;
 
       // Human-readable category name.
       // Since protocol **v25**.
       category_name: string;
 
       // Localized category names.
       // Since protocol **v25**.
       category_name_i18n?: { [lang_tag: string]: string };
     }
 
   .. ts:def:: InventoryPayloadUnit
 
     interface InventoryPayloadUnit {
       // Unit identifier.
       // Since protocol **v25**.
       unit: Slug;
 
       // Human-readable long label.
       // Since protocol **v25**.
       unit_name_long: string;
 
       // Localized long labels.
       // Since protocol **v25**.
       unit_name_long_i18n?: { [lang_tag: string]: string };
 
       // Human-readable short label.
       // Since protocol **v25**.
       unit_name_short: string;
 
       // Localized short labels.
       // Since protocol **v25**.
       unit_name_short_i18n?: { [lang_tag: string]: string };
 
       // Whether fractional quantities are allowed for this unit.
       // Since protocol **v25**.
       unit_allow_fraction: boolean;
 
       // Maximum fractional precision (0-6) enforced for this unit.
       // Since protocol **v25**.
       unit_precision_level: Integer;
     }