Project

General

Profile

Specification » History » Version 23

Soh Keong, 11/17/2022 11:52 AM

1 5 Soh Keong
{{toc}}
2
3 1 Soh Keong
h1. Specification
4
5 4 Soh Keong
h2. Programming Guide
6 1 Soh Keong
7
h3. Jar version 
8
9 11 Soh Keong
|_. version |_. Description        |
10
| 2.8       | Init                 |
11
| 2.8.1     | Fixed shipping error | 
12 22 Soh Keong
| 2.10      | Added TaxID          |
13 1 Soh Keong
14
h3. Jar File Download
15
16 23 Soh Keong
"Jar":/redmine/attachments/download/725/BVService-2.10.jar
17 1 Soh Keong
"Lib":/redmine/attachments/download/484/lib.rar
18
"Properties":/redmine/attachments/download/485/service.properties
19
20
h3. properties file
21
22
* *service.properties*
23
24
# *json.url.mom*            - Provided by POS
25
# *json.key*                - Provided by POS
26
# *aes.key*                 - Provided by POS
27
# *connection.timeout*      - Set connection timeout
28
# *connection.read.timeout* - Set connection red timeout
29 2 Soh Keong
30 7 Soh Keong
h2. flow chart
31
32 17 Soh Keong
h3. Taiwan
33
34 18 Soh Keong
!cancelFlow_TW.jpg!
35 1 Soh Keong
36 18 Soh Keong
h3. Hong Kong
37 1 Soh Keong
38 18 Soh Keong
!cancelFlow_HK.jpg!
39 7 Soh Keong
40 2 Soh Keong
h2. Methods
41
42
h3. Common Instance
43
44
<pre>
45
com.bv.ws.service.MomService service = new com.bv.ws.service.MomService();
46
</pre>
47
48 10 Soh Keong
h3. getMomBeanByOrderId / getCancelMomByOrderId / getRegistrationBeanByOrderId / getCancelRegistrationBeanByOrderId / getRenewalBeanByOrderId / getCancelRenewalBeanByOrderId
49 3 Soh Keong
50
<pre>
51 1 Soh Keong
com.bv.ws.model.MomBean momBean = service.getMomBeanByOrderId(Connection connStore, String orderId);
52 10 Soh Keong
com.bv.ws.model.MomBean momBean = service.getCancelMomByOrderId(Connection connUsa, Connection connStore, String orderId);
53
com.bv.ws.model.MomBean momBean = service.getRegistrationBeanByOrderId(Connection conn, String orderId)
54
com.bv.ws.model.MomBean momBean = service.getCancelRegistrationBeanByOrderId(Connection conn, String orderId)
55
com.bv.ws.model.MomBean momBean = service.getRenewalBeanByOrderId (Connection conn, String orderId)
56
com.bv.ws.model.MomBean momBean = service.getCancelRenewalBeanByOrderId(Connection conn, String orderId)
57 8 Soh Keong
</pre>
58
59
"com.bv.ws.model.MomBean":/redmine/projects/aces/wiki/Specification#Common-Bean-MomBean
60
61 21 Soh Keong
h3. addOrder (UpdateOrder)
62 8 Soh Keong
63 12 Soh Keong
<pre>
64 16 Soh Keong
com.bv.ws.model.ResultBean resultBean = service.addOrder(MomBean bean)
65 12 Soh Keong
</pre>
66 4 Soh Keong
67 12 Soh Keong
"com.bv.ws.model.MomBean":/redmine/projects/aces/wiki/Specification#Common-Bean-MomBean
68 15 Soh Keong
"com.bv.ws.model.ResultBean":/redmine/projects/aces/wiki/Specification#Common-Bean-ResultBean
69 12 Soh Keong
70
71 21 Soh Keong
h3. checkShippingStatus (QueryOrderbyNo)
72 4 Soh Keong
73 1 Soh Keong
<pre>
74 12 Soh Keong
com.bv.ws.model.QueryResultBean resutlBean = service.checkShippingStatus(QueryOrderBean bean)
75 4 Soh Keong
</pre>
76
77
* *com.bv.ws.model.QueryOrderBean *
78 1 Soh Keong
> * *orderId*        - String
79
> * *countryCode*    - String
80
81
* *com.bv.ws.model.QueryResultBean*
82
> * *errCode*          - String
83
> * *errMessage*       - String
84 5 Soh Keong
> * *invoiceStatus*    - String ("return" = good had return : empty = yet return)
85 4 Soh Keong
> * *shipped*          - boolean
86
87 21 Soh Keong
h3. updateCancelRequestBeforeApproval / cancelCancelRequest / updateCancelRequestAfterApproval / updateCancelStatus (ProcessOrder)
88 4 Soh Keong
89 5 Soh Keong
<pre>
90 1 Soh Keong
com.bv.ws.model.ResultBean resultBean = service.updateCancelRequestBeforeApproval(UpdateOrderBean bean)
91 6 Soh Keong
com.bv.ws.model.ResultBean resultBean = service.cancelCancelRequest(UpdateOrderBean bean)
92
com.bv.ws.model.ResultBean resultBean = service.updateCancelRequestAfterApproval(UpdateOrderBean bean)
93 7 Soh Keong
com.bv.ws.model.ResultBean resultBean = service.updateCancelStatus(UpdateOrderBean bean)
94 5 Soh Keong
</pre>
95
96
* *com.bv.ws.model.UpdateOrderBean*
97
> * *orderId*          - String
98
> * *countryCode*      - String
99 13 Soh Keong
> * *stockistCode*     - com.bv.ws.constant.CommonConstant.STOCKIST_CODE_ONLINE
100 1 Soh Keong
> * *orderList*        - String
101 5 Soh Keong
>> * *orderId*         - String
102 1 Soh Keong
>> * *cancelRequest*   - String (NO NEED to set value, auto fixed by calling difference method) 
103 6 Soh Keong
NOTE: R=Before Approval; Y=After Approval; 
104
>> * *orderStatus*     -String (default to 'cancel') 
105
106 15 Soh Keong
"com.bv.ws.model.ResultBean":/redmine/projects/aces/wiki/Specification#Common-Bean-ResultBean
107 5 Soh Keong
108 6 Soh Keong
109 14 Soh Keong
h3. getDeliveryAddressByOrderId
110
111
<pre>
112
com.bv.ws.model.MomShippingAddressBean addressBean = service.getDeliveryAddressByOrderId(Connection conn, String orderId) 
113
</pre>
114
115
"com.bv.ws.model.MomShippingAddressBean ":/redmine/projects/aces/wiki/Specification#Common-Bean-MomShippingAddressBean
116
117
118 21 Soh Keong
h3. updateDeliveryAddress (ModifyOrder)
119 14 Soh Keong
120
<pre>
121
com.bv.ws.model.ResultBean resultBean =  service.updateDeliveryAddress(MomShippingAddressBean bean)
122
</pre>
123
124
"com.bv.ws.model.MomShippingAddressBean ":/redmine/projects/aces/wiki/Specification#Common-Bean-MomShippingAddressBean
125 15 Soh Keong
"com.bv.ws.model.ResultBean":/redmine/projects/aces/wiki/Specification#Common-Bean-ResultBean
126 14 Soh Keong
127
128 4 Soh Keong
h3. getShippingCountryByOrderId
129
130 1 Soh Keong
<pre>
131
String shippingCountry = service.getShippingCountryByOrderId(Connection connStore, String orderId);
132
</pre>
133 6 Soh Keong
134
135 9 Soh Keong
h3. Common Bean - MomBean
136 4 Soh Keong
137 3 Soh Keong
* *com.bv.ws.model.MomBean*
138
> * *orderId*          - String
139
> * *countryCode*      - String
140
> * *deliveryAddress*  - String
141
> * *memberIc*         - String
142
> * *telNo*            - String
143
> * *receiverName*     - String
144
> * *stockistCode*     - String
145
> * *orderDate*        - Date
146
> * *memberId*         - String
147
> * *invoiceAmount*    - double
148
> * *processDate*      - Date
149
> * *collectorName*    - String
150
> * *collectorIc*      - String
151
> * *collectorContact* - String
152
> * *deliveryType*     - String
153
> * *pickupStore*      - String
154
> * *approvalCode*     - String
155
> * *freightCharges*   - double
156
> * *purchaserName*    - String
157
> * *ewalletAdminFee*  - double
158
> * *currency*         - String
159
> * *originalOrdNo*    - String
160
> * *onlineMall*       - String
161
> * *warehouse*        - String
162
> * *lossFee*          - double
163
> * *productList*       
164
>> * *setId*           - String
165
>> * *productId*       - String
166
>> * *productType*     - String
167
>> * *quantity*        - int
168
>> * *setSold*         - int
169
>> * *productPrice*    - double
170
>> * *deductStock*     - String
171
>> * *childPrice*      - double
172
>> * *childTotalPrice* - double
173 1 Soh Keong
174
175
h3. Common Bean - MomShippingAddressBean
176
177
* *com.bv.ws.model.MomShippingAddressBean*
178
> * *orderId*          - String
179
> * *countryCode*      - String
180 14 Soh Keong
> * *deliveryAddress*  - String
181
> * *memberIc*         - String
182
> * *telNo*            - String
183
> * *receiverName*     - String
184 15 Soh Keong
185
186
h3. Common Bean - ResultBean
187
188
* *com.bv.ws.model.ResultBean*
189
> * *errCode*          - String
190
> * *errMessage*       - String