summaryrefslogtreecommitdiff
path: root/design-documents/016-backoffice-order-management.rst
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-03-30 15:57:04 -0300
committerSebastian <sebasjm@gmail.com>2021-03-30 15:57:26 -0300
commitc768a39a846258f97a25cd122aaf0f00ffb3c83c (patch)
treea67d3bf763878e400e371f44da5d474ab911e785 /design-documents/016-backoffice-order-management.rst
parent3e364b9c8daab32566c945d369cba5de9f74e801 (diff)
downloaddocs-c768a39a846258f97a25cd122aaf0f00ffb3c83c.tar.gz
docs-c768a39a846258f97a25cd122aaf0f00ffb3c83c.tar.bz2
docs-c768a39a846258f97a25cd122aaf0f00ffb3c83c.zip
details page
Diffstat (limited to 'design-documents/016-backoffice-order-management.rst')
-rw-r--r--design-documents/016-backoffice-order-management.rst106
1 files changed, 65 insertions, 41 deletions
diff --git a/design-documents/016-backoffice-order-management.rst b/design-documents/016-backoffice-order-management.rst
index ec68b22e..7b2acc83 100644
--- a/design-documents/016-backoffice-order-management.rst
+++ b/design-documents/016-backoffice-order-management.rst
@@ -24,7 +24,7 @@ User should use the backoffice to manage orders by:
* searching for orders
* showing details about the order and the activity history
* refund order that are refundable
-* create orders
+* create orders ( if admin )
Proposed Solution
=================
@@ -35,14 +35,6 @@ Listing orders
.. image:: ../backoffice-order-list.svg
:width: 800
-Will show the SearchBar component that allow multiple filter.
-Filter will allow paid, refunded, wired status and date.
-
- * paid: yes/no
- * refunded: yes/no
- * wired: yes/no
- * date: 'dd/MM/yyyy'
-
4 tabs will be show for a easy access to common filter, click on any of this and
search will reset all filter except date
@@ -60,7 +52,7 @@ Columns for the order listings will be:
Actions per row:
* refund: pop up with amount and reason (select box and text)
-* copy payment id
+* copy payment url (if not status==unpaid)
* view details
An export button will allow the user to download the result page in CSV format.
@@ -75,24 +67,16 @@ An infinity scroll is propose instead of a pagination, reasons:
Create orders
-------------
-Form with 4 fields:
+Form with 2 fields from MinimalOrderDetail:
* amount
* summary
-* time until refund ( dropdown: 1week, 2weeks, custom )
-* description
-* payment method
Creation order success
**********************
-Example message:
-
- Creation successful
-
- We've create an order for for USD:10.00.
-
- Send url to the customer: ``taler_pay_uri``
+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.
action buttons that allow the following:
@@ -136,19 +120,40 @@ On line per status updated, with datetime and a short description.
Info taken from:
-* refund_details
-* wire_reports
-* wire_details
-* contractTerm.extra for custom notes ({date: timestamp, description: string})
+* refund_details: a row showing date an amount
+
+* wire_details: a row date and id
+
+
+ About wire details
+
+ Normally one wire transfer will involve more than one payment from the same
+ exchange. And an order can have multiple wire transfers if the payment
+ involved more than one exchange.
+
+
+
+Error status
+************
+
+This section is not going to be shown if there is no error
+
+* Wire Error: info taking from wire_reports in contractTerm. for every element
+ in the list show hint and error code
+
+* Exchange Error: connection with exchange failed, info taking from exchange_ec
+ and exhange_hc
Payment details
***************
+If the order was claimed
+
* summary
-* amount (deposit_total)
-* fee
+* amount (contract.amount)
+* fee (contract.amount - deposit_total)
* refund_amount (if status is refunded)
-* net (amount - fee - refund)
+* net (deposit_total - refund_amount)
* current status
@@ -183,15 +188,6 @@ collapsed as default. show disabled if unpaid
* auto_refund
-
-Last response from exchange
-***************************
-
-collapsed as default, showing a green check if everything is ok or a yellow
-warning otherwise
-
-When open show 2 boxes with text translated from ``exchange_ec`` and ``exchange_hc``
-
refund popup
--------------
@@ -202,8 +198,6 @@ If there is any refund:
* if expanded show a timeline vertically showing amount a reason
``refund_details``
-Show a small notice telling that the refund is going to take ``refund_delay`` time.
-
Warn if there is a pending refund when ``refund_pending`` is true
Ask for:
@@ -214,19 +208,33 @@ Ask for:
* drop down options: duplicated, fraudulent, requested by customer, other
* after selecting, free text for additional information
-examples
---------
+.. image:: ../backoffice-order-refund.svg
+ :width: 800
+
+
+Example of details by status
+----------------------------
.. image:: ../backoffice-order-details.paid.svg
:width: 800
+.. image:: ../backoffice-order-details.unpaid.svg
+ :width: 800
+
+.. image:: ../backoffice-order-details.claimed.svg
+ :width: 800
+
+.. image:: ../backoffice-order-details.refunded.svg
+ :width: 800
Alternatives
============
+pagination
+-----------
order list was originally thought with pagination footer
.. image:: ../backoffice-order-list.pagination.svg
@@ -235,6 +243,22 @@ order list was originally thought with pagination footer
ascending boolean flag cloud be eliminated using the load before and load after
and a design without random access to pages was proposed
+search box
+----------
+
+A SearchBox was considered for managing filter.
+Filter will allow paid, refunded, wired status and date.
+
+* paid: yes/no
+* refunded: yes/no
+* wired: yes/no
+* date: 'dd/MM/yyyy'
+
+The UI of the search box is an input field with tags showing ``field=value`` for
+any filter set. Additionally a custom criteria can be supported like
+``date>last_week`` or ``amount>USD:10``
+
+
Discussion / Q&A
================