summaryrefslogtreecommitdiff
path: root/design-documents/016-backoffice-order-managment.rst
blob: 738b2bd249665a1a313e553826898da2b7ff0c32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
Design Doc 016: Merchant backoffice Routing
###########################################

Summary
=======

This document describe the complete list features for orders management and how
will be shown.

Motivation
==========

User will use the backoffice to manage their orders and verify the status of the
current and past orders.

Requirements
============

Access all information provided from the Merchant Backend API in a
understandable and accesible way

Proposed Solution
=================

The propose solution use:

* listing
* creation
* details
* refund popup

Listing orders
--------------

.. image:: ../backoffice-order-list.v2.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

* paid (default) 
* refunded
* not wired
* all (empty filter box)

Columns for the order listings will be:

* date in 'dd/MM/yyyy HH:mm:ss' format
* amount: value and currency
* summary

Actions per row:

* refund: pop up with amount and reason (select box and text)
* copy payment id
* view details

An export button will allow the user to download the result page in CSV format.

An infinity scroll is propose instead of a pagination, reasons:

* users usually does not jump from one page to anoter using random access
* if the user want to search, is going to limit the result using filters
* no need to go back after loading more result
* it could be triggered by scrollin, with buttons (or both)

Create orders
-------------

Form with 4 fields:

* 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``

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)

Order details
-------------

Status text should be set with a backgournd color for easier recognition when
indicated:

* paid: green
* claimed: light-green
* unpaid: grey
* refunded: red

Header
******

This is a resume of most important information

* big status with color 
* date
* total

  - deposit_total (if not refunded)
  - refund_amount (if status is refunded)
  - deposit_total - refund amount (if refunded partially)

* order_status_url
* taler_pay_uri (if unpaid)
* actions: refund (if not refunded), add note, copy order_status_url

Timeline of events
******************

Event of status changed over time describe vertically. 
Sorted from newest to oldest.
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})

Payment details
***************

* summary
* amount (deposit_total)
* fee 
* refund_amount (if status is refunded)
* net (amount - fee - refund)
* current status

  
Contract Terms
**************

collapsed as default. show disabled if unpaid

* summary
* amount
* fulfillment_url, if present
* max fee
* max fire fee
* wire_fee_amortization
* list of (exchange | auditor) name and url
* products table: list of products, one row per product

  * description
  * quantity
  * total price
  * total tax
  * sum at the bottom

* horizontal timeline of importants dates in the contract

  * start at contract creation time
  * show current date
  * pay_deadline
  * wire_transfer_deadline
  * refund_deadline
  * delivery_date (immediately if null)
  * 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
--------------

If there is any refund:

* show total refund from ``refund_amount``
* a + sign to show more information
* if exapanded 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:

* amount
* reason: concatenation of the next values

  * drop down options: duplicated, fraudulent, requested by customer, other
  * aflter selecting, free text for aditional information

Alternatives
============


order list was originaly thought with pagination footer

.. image:: ../backoffice-order-list.v2-pagination.svg
  :width: 800

ascending boolean flag cloud be eliminated using the load before and load after
and a design without random access to pages was proposed


Q&A
===

* Shall we show merchant information from the ContractTerm in the order detail?

* Order creation was first thouth as out of scope but should be useful for
  testing purpose or when frontend is not yet integrated with taler merchant
  backend. Shall we skip it?

* Do we have the date and time of when the order goes from these states?

  * claimed => paid (maybe last wire_details.execution_time with confirmed = true )
  * unpaid => claimed (maybe contractTerm.timestamp)