diff options
Diffstat (limited to 'design-documents/016-backoffice-order-management.rst')
| -rw-r--r-- | design-documents/016-backoffice-order-management.rst | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/design-documents/016-backoffice-order-management.rst b/design-documents/016-backoffice-order-management.rst index 583661c1..09af5eb5 100644 --- a/design-documents/016-backoffice-order-management.rst +++ b/design-documents/016-backoffice-order-management.rst @@ -1,5 +1,5 @@ -Design Doc 016: Backoffice Order Management -########################################### +DD 16: Backoffice Order Management +################################## Summary ======= @@ -32,13 +32,13 @@ Proposed Solution Listing orders -------------- -.. image:: ../backoffice-order-list.svg +.. image:: ../images/backoffice-order-list.svg :width: 800 -4 tabs will be show for a easy access to common filter, click on any of this and +4 tabs will be show for an easy access to common filter, click on any of this and search will reset all filter except date -* paid (default) +* paid (default) * refunded * not wired * all (empty filter box) @@ -78,7 +78,7 @@ this form is divided into 4 sections * ``payment``: where some default of the payment processing can be changed * ``extra``: where the merchant can add extra information in JSON format - + Create order: Product section ............................. @@ -88,26 +88,26 @@ This section has two parts: The first part will add/remove product from the current stock. * ``name``: search box to select product by description field. if not found it - will be a 'create new' option leading to the create product without loosing + will be a 'create new' option leading to the create product without losing context * ``quantity``: mandatory The second part will add non inventory product. To add a product a :ref:`create product <backoffice-create-product>` form will be shown. The product in the list -can be edited or deleted from the list. +can be edited or deleted from the list. In both cases, the total unit and price of the products will be calculated and shown in the bottom of the section. If the merchant collapse one of the product list a line with a resume of the total price and units will be shown. -.. image:: ../backoffice-order-create.product-section.svg +.. image:: ../images/backoffice-order-create.product-section.svg :width: 800 Create order: Price section ........................... -This section has 2 scenarios. +This section has 2 scenarios. The fist one is without products being added: the ``order price`` and ``summary`` inputs will be shown. @@ -115,9 +115,9 @@ The fist one is without products being added: the ``order price`` and If there is at least one product added, the ``total products price`` as the sum of all products prices will be shown. The ``order price`` will default to ``total products price``. The ``products taxes`` and ``profit`` will be shown -since ``order price`` cannot be less that ``product taxes``. +since ``order price`` cannot be less that ``product taxes``. -.. image:: ../backoffice-order-create.price-section.svg +.. image:: ../images/backoffice-order-create.price-section.svg :width: 800 Create order: Payment section @@ -126,7 +126,7 @@ Create order: Payment section This section show optional values that can be overwritten by the merchant * ``refund deadline``: calendar type of input. default from instance - + * ``pay deadline``: calendar type of input. default from instance * ``auto refund deadline``: calendar type of input. default empty, optional. @@ -142,7 +142,7 @@ This section show optional values that can be overwritten by the merchant * ``wire_fee_amortization``: default value from the instance -.. image:: ../backoffice-order-create.payment-section.svg +.. image:: ../images/backoffice-order-create.payment-section.svg :width: 800 Create order: all section expanded @@ -150,17 +150,17 @@ Create order: all section expanded An example of how all section in a page will be shown. -.. image:: ../backoffice-order-create.all-expanded.svg +.. image:: ../images/backoffice-order-create.all-expanded.svg :width: 800 Creation order success -********************** +...................... A success message showing the amount, summary and the order id. Additionally the -taler_pay_uri can be shown to be copied to send to the customer. +taler_pay_uri can be shown to be copied to send to the customer. -action buttons that allow the following: +action buttons that allow the following: * create another payment: go to the create payment page again * view details: show details of the payment (see page) @@ -177,11 +177,11 @@ indicated: * refunded: red Header -^^^^^^ +...... This is a resume of most important information -* big status with color +* big status with color * date * total @@ -194,9 +194,9 @@ This is a resume of most important information * actions: refund (if not refunded), add note, copy order_status_url Timeline of events -^^^^^^^^^^^^^^^^^^ +.................. -Event of status changed over time describe vertically. +Event of status changed over time describe vertically. Sorted from newest to oldest. On line per status updated, with datetime and a short description. @@ -216,7 +216,7 @@ Info taken from: Error status -^^^^^^^^^^^^ +............ This section is not going to be shown if there is no error @@ -227,7 +227,7 @@ This section is not going to be shown if there is no error and exchange_hc Payment details -^^^^^^^^^^^^^^^ +............... If the order was claimed @@ -238,9 +238,9 @@ If the order was claimed * net (deposit_total - refund_amount) * current status - + Contract Terms -^^^^^^^^^^^^^^ +.............. collapsed as default. show disabled if unpaid @@ -271,7 +271,7 @@ collapsed as default. show disabled if unpaid refund popup ------------- +............ If there is any refund: @@ -284,17 +284,17 @@ Warn if there is a pending refund when ``refund_pending`` is true Ask for: * amount: default 0, show max amount refundable (order amount - already - refunded) + refunded) * reason: concatenation of the next values * drop down options: duplicated, requested by customer, other * after selecting, free text for additional information -.. image:: ../backoffice-order-refund.svg +.. image:: ../images/backoffice-order-refund.svg :width: 800 -.. image:: ../backoffice-order-refund.already.svg +.. image:: ../images/backoffice-order-refund.already.svg :width: 800 Example of details by status @@ -302,16 +302,16 @@ Example of details by status -.. image:: ../backoffice-order-details.paid.svg +.. image:: ../images/backoffice-order-details.paid.svg :width: 800 -.. image:: ../backoffice-order-details.unpaid.svg +.. image:: ../images/backoffice-order-details.unpaid.svg :width: 800 -.. image:: ../backoffice-order-details.claimed.svg +.. image:: ../images/backoffice-order-details.claimed.svg :width: 800 -.. image:: ../backoffice-order-details.refunded.svg +.. image:: ../images/backoffice-order-details.refunded.svg :width: 800 @@ -320,10 +320,10 @@ Alternatives pagination ------------ +---------- order list was originally thought with pagination footer -.. image:: ../backoffice-order-list.pagination.svg +.. image:: ../images/backoffice-order-list.pagination.svg :width: 800 ascending boolean flag cloud be eliminated using the load before and load after @@ -363,11 +363,11 @@ Discussion / Q&A Is there any other case? Is this taking into account auto_refund? * Field left out in the order creation: - + * contractTerm.summary_i18n: it makes the UI complex * contractTerm.order_id: should be created by the backend * contractTerm.timestamp: defined by backend * contractTerm.merchant_pub: filled by the backend * contractTerm.merchant_base_url: filled by the backend * contractTerm.h_wire: defined by the backend - * contractTerm.nonce: not used
\ No newline at end of file + * contractTerm.nonce: not used |