Subversion Repositories SmartDukaan

Rev

Rev 4295 | Rev 4324 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
68 ashish 1
namespace java in.shop2020.model.v1.order
95 ashish 2
namespace py shop2020.thriftpy.model.v1.order
3374 rajveer 3
 
4
include "GenericService.thrift"
5
 
68 ashish 6
/***
7
	Order objects.
8
*/
483 rajveer 9
enum OrderStatus{
845 chandransh 10
	PAYMENT_PENDING,
11
	PAYMENT_FAILED,
483 rajveer 12
	INIT,
13
	SUBMITTED_FOR_PROCESSING,
14
	ACCEPTED,
15
	INVENTORY_LOW,
495 rajveer 16
	REJECTED,
483 rajveer 17
	BILLED,
4245 rajveer 18
	PAYMENT_FLAGGED, 
483 rajveer 19
	SHIPPED_FROM_WH,
20
	SHIPPED_TO_LOGST,
4245 rajveer 21
	PAYMENT_FLAGGED_DENIED,      
483 rajveer 22
	DELIVERY_SUCCESS,
4245 rajveer 23
	CANCEL_REQUEST_RECEIVED,
24
	CANCEL_REQUEST_CONFIRMED,
25
	CANCELLED_ON_CUSTOMER_REQUEST,
26
	CANCELLED_DUE_TO_LOW_INVENTORY,
27
	COMPLETED,                  //Not Used
483 rajveer 28
	CANCELED,
2537 chandransh 29
	FAILED,
30
	SALES_RETURN_IN_TRANSIT,
2611 chandransh 31
	SALES_RET_RECEIVED,
2537 chandransh 32
	DOA_PICKUP_REQUESTED,
33
	DOA_RETURN_AUTHORIZED,
34
	DOA_RETURN_IN_TRANSIT,
2600 chandransh 35
	DOA_RECEIVED,
2537 chandransh 36
	DOA_CERT_INVALID,
2614 chandransh 37
	DOA_CERT_VALID,
38
	SALES_RET_RESHIPPED,
39
	DOA_INVALID_RESHIPPED,
40
	DOA_RESHIPPED,
41
	SALES_RET_REFUNDED,
42
	DOA_VALID_REFUNDED,
43
	DOA_INVALID_REFUNDED,
4303 rajveer 44
	REFUNDED,
45
	LOW_INV_PO_RAISED,
46
	LOW_INV_REVERSAL_IN_PROCESS,
47
	LOW_INV_NOT_AVAILABLE_AT_HOTSPOT
483 rajveer 48
}
49
 
4245 rajveer 50
 
483 rajveer 51
enum TransactionStatus{
52
	INIT,
53
	IN_PROCESS,
54
	COMPLETED,
2964 chandransh 55
	FAILED,
3060 chandransh 56
	AUTHORIZED,
4245 rajveer 57
	COD_IN_PROCESS,
58
	FLAGGED
483 rajveer 59
}
60
 
4008 mandeep.dh 61
enum ExtraTransactionProcessingType {
62
    COD_VERIFICATION,
4245 rajveer 63
    DELAYED_DELIVERY,
64
    PAYMENT_FLAGGED
4008 mandeep.dh 65
}
66
 
483 rajveer 67
struct LineItem{
68
	1:i64 id,
698 chandransh 69
	2:i64 item_id,
4008 mandeep.dh 70
	3:string productGroup,
956 chandransh 71
	4:string brand,
72
	5:string model_number,
73
	6:string color
74
	7:string model_name,
75
	8:string extra_info,
76
	9:double quantity,
77
	10:double unit_price,
78
	11:double unit_weight,
79
	12:double total_price,
1000 varun.gupt 80
	13:double transfer_price,
2780 chandransh 81
	14:double total_weight,
82
	15:optional i64 imei_number,
4172 rajveer 83
	16:optional string item_number,
4295 varun.gupt 84
	17:optional string dealText,
85
	18:i64 warrantry_expiry_timestamp
483 rajveer 86
}
87
 
3553 chandransh 88
enum DelayReason {
89
	INVENTORY_LOW_PHASED_OUT,
90
	INVENTORY_LOW_COLOR_NOT_AVAILABLE,
91
	INVENTORY_LOW_REVERSAL_NOT_ON_TIME,
92
	INVENTORY_LOW_PRODUCT_NOT_SEALED,
93
	COURIER_DELAY_NOT_DELIVERED_TO_COURIER_ON_TIME,
94
	COURIER_DELAY_DID_NOT_CONNECT,
95
	COURIER_DELAY_CUSTOMER_NOT_AVAILABLE,
96
	COURIER_DELAY_INCORRECT_ADDRESS
97
	COURIER_DELAY_OCTROI_DELAY,
98
	COURIER_DELAY_FORCES_OF_NATURE,
99
	COD_VERIFICATION_DELAY,
100
	PAYMENT_FLAGGED,
101
	OTHERS
102
}
483 rajveer 103
 
104
struct Order{
105
	1:i64 id,
106
	2:i64 warehouse_id,
107
	/**
108
		item info
109
	**/
110
	3:list<LineItem> lineitems,
111
	/**
112
	  logistics info
113
	**/
114
	4:i64 logistics_provider_id,
115
	5:string airwaybill_no,
116
	6:string tracking_id,
117
	7:i64 expected_delivery_time,
118
	/**
119
	  customer info
120
	**/
121
	8:i64 customer_id,
122
	9:string customer_name,
123
	10:string customer_mobilenumber,
124
	11:string customer_pincode,
735 chandransh 125
	12:string customer_address1,
126
	13:string customer_address2,
127
	14:string customer_email,
128
	15:string customer_city,
129
	16:string customer_state,
483 rajveer 130
 
131
	/**
132
		status and misc info
133
	**/
735 chandransh 134
	17:OrderStatus status,
135
	18:string statusDescription,
136
	19:double total_amount,
137
	20:double total_weight,
483 rajveer 138
	/**
139
		billing info
140
	**/
735 chandransh 141
	21:string invoice_number,
142
	22:string billed_by,
483 rajveer 143
	/**
144
		timestamps
145
	**/
735 chandransh 146
	23:i64 created_timestamp,
147
	24:i64 accepted_timestamp,
148
	25:i64 billing_timestamp,
149
	26:i64 shipping_timestamp,
1115 chandransh 150
	27:i64 pickup_timestamp,
151
	28:i64 delivery_timestamp,
1210 chandransh 152
	29:i64 outofstock_timestamp,
153
	30:i64 jacket_number,
1223 chandransh 154
	31:string receiver,
155
	32:i64 batchNo,
2537 chandransh 156
	33:i64 serialNo,
157
	34:bool doaFlag,
2675 vikas 158
	35:string pickupRequestNo,
2819 chandransh 159
	36:i64 transactionId,
3060 chandransh 160
	37:string purchaseOrderNo,
3553 chandransh 161
	38:bool cod,
4004 chandransh 162
	39:DelayReason delayReason,
163
	40:i64 promised_delivery_time,
164
	41:i64 expected_shipping_time,
4102 chandransh 165
	42:i64 verification_timestamp,
4192 anupam.sin 166
	43:i64 promised_shipping_time,
167
	44:optional i64 reship_timestamp,
168
	45:optional i64 refund_timestamp,
4245 rajveer 169
	46:optional i64 new_order_id,
4269 anupam.sin 170
	47:OrderStatus previousStatus,
171
	48:i64 vendorId
483 rajveer 172
}
173
 
4245 rajveer 174
struct OrderStatusAuditTrail{
175
	1:i64 id,
176
	2:i64 orderId,
177
	3:i64 status,
178
	4:i64 timestamp,
179
	5:i64 description
180
}
181
 
483 rajveer 182
struct Transaction{
183
	1:i64 id,
184
	2:list<Order> orders,
680 rajveer 185
	3:i64 createdOn,
186
	4:TransactionStatus transactionStatus,
187
	5:string statusDescription,
188
	6:i64 shoppingCartid,
2219 varun.gupt 189
	7:i64 customer_id,
2814 vikas 190
	8:string coupon_code,
191
	9:string sessionSource,
3858 vikas 192
	10:i64 sessionStartTime,
193
	11:string firstSource,
194
    12:i64 firstSourceTime
483 rajveer 195
}
196
 
197
struct Alert{
198
	1:i64 id,
199
	2:i64 order_id,
200
	3:i64 type,
201
	4:i64 time_set,
202
	5:string comment,
203
	6:i64 time_unset
204
}
205
 
2688 chandransh 206
struct ReturnOrder{
207
	1:i64 orderId,
2697 chandransh 208
	2:i64 warehouseId,
209
    3:i64 jacketNumber,
210
    4:string invoiceNumber,
211
    5:i64 itemId,
212
    6:string productGroup,
213
    7:string brand,
214
    8:string modelNumber,
215
    9:string modelName,
216
    10:string color,
217
    11:double totalPrice,
218
    12:double transferPrice,
219
    13:bool processedStatus,
220
    14:i64 createdAt,
221
    15:i64 processedAt
2688 chandransh 222
}
223
 
4303 rajveer 224
enum HotspotAction{
225
	PO_RAISED,
226
	REVERSAL_INITIATED,
227
	NOT_AVAILABLE
228
}
229
 
483 rajveer 230
exception TransactionServiceException{
231
	1:i32 errorCode,
232
	2:string message
233
}
234
 
3374 rajveer 235
service TransactionService extends GenericService.GenericService{
483 rajveer 236
 
237
	i64 createTransaction(1:Transaction transaction) throws (1:TransactionServiceException ex),
238
 
239
	//	Get transaction methods.
240
	Transaction getTransaction(1:i64 id) throws (1:TransactionServiceException ex),
241
	list<Transaction> getTransactionsForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:TransactionStatus status) throws (1:TransactionServiceException ex),
242
	list<Transaction> getTransactionsForShoppingCartId(1:i64 shoppingCartId) throws (1:TransactionServiceException ex),
243
	TransactionStatus getTransactionStatus(1:i64 transactionId) throws (1:TransactionServiceException ex),
244
	bool changeTransactionStatus(1:i64 transactionId, 2:TransactionStatus status, 3:string description) throws (1:TransactionServiceException ex),
1382 varun.gupt 245
 
1398 varun.gupt 246
	bool enqueueTransactionInfoEmail(1:i64 transactionId) throws (1:TransactionServiceException ex),
1382 varun.gupt 247
 
483 rajveer 248
	list<Order> getAllOrders(1:OrderStatus status, 2:i64 from_date, 3:i64 to_date, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
1111 varun.gupt 249
 
1115 chandransh 250
	/**
4133 chandransh 251
	Returns at most 'limit' orders with the given statuses for the given warehouse starting from the given offset.
252
	Pass the status as null and the limit as 0 to ignore them.
253
	*/
254
	list<Order> getOrdersInBatch(1:list<OrderStatus> statuses, 2:i64 offset, 3:i64 limit, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
255
 
256
	/**
257
	Returns the count of orders with the given statuses assigned to the given warehouse.
258
	*/
259
	i32 getOrderCount(1:list<OrderStatus> statuses, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
260
 
261
	/**
1115 chandransh 262
	Returns orders within a range of their billing dates
263
	*/
1000 varun.gupt 264
	list<Order> getOrdersByBillingDate(1:OrderStatus status, 2:i64 start_billing_date, 3:i64 end_billing_date, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
1111 varun.gupt 265
 
1382 varun.gupt 266
	/**
3427 chandransh 267
	Returns orders for a particular provider and warehouse which were shipped between the given dates.
3451 chandransh 268
	Returned orders comprise of COD orders if cod parameter is true. It comprises of prepaid orders otherwise. 
269
	Pass providerId and warehouseId as -1 to ignore both these parameters.
3427 chandransh 270
	*/
3451 chandransh 271
	list<Order> getOrdersByShippingDate(1:i64 fromShippingDate, 2:i64 toShippingDate, 3:i64 providerId, 4:i64 warehouseId, 5:bool cod) throws (1:TransactionServiceException ex),
3427 chandransh 272
 
273
	/**
1382 varun.gupt 274
	Returns order ids for orders which can be returned
275
	*/
276
	list<i64> getReturnableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
277
 
278
	/**
279
	Returns order ids for orders which can be cancelled
280
	*/
281
	list<i64> getCancellableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
282
 
483 rajveer 283
	bool changeOrderStatus(1:i64 orderId, 2:OrderStatus status, 3:string description) throws (1:TransactionServiceException ex),
1147 chandransh 284
 
285
	/**
1529 ankur.sing 286
	Returns list of orders for given transaction Id. Also filters based on customer Id so that
287
	only user who owns the transaction can view its order details.
288
	*/
289
	list<Order> getOrdersForTransaction(1:i64 transactionId 2:i64 customerId)  throws (1:TransactionServiceException ex),
3014 chandransh 290
 
291
	/**
292
	Returns list of orders for the given customer created between the given dates and having the given statuses.
293
	Pass and empty list to ignore filtering on statuses.
294
	*/	
295
	list<Order> getOrdersForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:list<OrderStatus> statuses) throws (1:TransactionServiceException ex),
1529 ankur.sing 296
 
483 rajveer 297
	i64 createOrder(1:Order order) throws (1:TransactionServiceException ex),
298
	Order getOrder(1:i64 id) throws (1:TransactionServiceException ex),
299
	list<LineItem> getLineItemsForOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
300
 
1529 ankur.sing 301
 
757 chandransh 302
	/**
1529 ankur.sing 303
	Returns an order for the order Id. Also checks if the order belongs to the customer whose Id is passed.
304
	Throws exception if either order Id is invalid or order does not below to the customer whose Id is passed.
305
	*/
306
	Order getOrderForCustomer(1:i64 orderId, 2:i64 customerId) throws (1:TransactionServiceException ex),
307
 
3060 chandransh 308
	//Alerts apis 
309
	list<Alert> getAlerts(1:i64 orderId, 2:bool valid),
310
	void setAlert(1:i64 orderId, 2:bool unset, 3:i64 type, 4: string comment),
311
 
1529 ankur.sing 312
	/**
3060 chandransh 313
	Return the number of valid orders. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
314
	*/
315
	i64 getValidOrderCount(),
316
 
317
	/**
318
	Returns the number of distinct customers who have done successful transactions
319
	*/
320
	i64 getNoOfCustomersWithSuccessfulTransaction(),
321
 
322
	/**
323
	Returns the minimum and maximum amounts of a valid order. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
324
	List contains two values, first minimum amount and second maximum amount.	
325
	*/
326
	list<double> getValidOrdersAmountRange(),
327
 
328
	/**
329
	Returns list of Orders in descending order by Order creation date. List is restricted to limit Orders.
330
	If limit is passed as 0, then all valid Orders are returned. 
331
	*/
332
	list<Order> getValidOrders(1:i64 limit),
333
 
334
	/**
335
	Create a batch of all the pending orders for the given warehouse.
336
	The returned list is orderd by created_timestamp.
337
	If there are no pending orders, an empty list is returned.
338
	*/
1223 chandransh 339
	list<Order> batchOrders(1:i64 warehouseId) throws (1:TransactionServiceException ex),
340
 
341
	/**
342
	Mark the given order as out of stock. Throws an exception if the order with the given Id couldn't be found. 
1244 chandransh 343
	*/
1210 chandransh 344
	bool markOrderAsOutOfStock(1:i64 orderId) throws (1:TransactionServiceException ex),
345
 
346
	/**
3060 chandransh 347
	Marks the given order as SUBMITTED_FOR_PROCESSING and updates the verified
348
	timestamp. It is intended to be used for COD orders but can be harmlessly 
349
	used for all other orders as well.
350
	Throws an exception if no such order exists.
757 chandransh 351
	*/
3060 chandransh 352
	bool verifyOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
1115 chandransh 353
 
354
	/**
3060 chandransh 355
	Marks the given order as ACCEPTED and updates the accepted timestamp. If the
356
	given order is not a COD order, it also captures the payment if the same has
357
	not been captured.
358
	Throws an exception if no such order exists.
359
	*/
360
	bool acceptOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
361
 
362
	/**
363
	Add billing details such as the bill number and the biller to the Order.
364
	Adds jacket number, item number and IMEI no. to the order. Doesn't update
365
	the IMEI no. if a -1 is supplied.
366
	Also, it generates an invoice number for the order, marks the order as
367
	BILLED and sets the billing timestamp.
368
	Returns false if it doesn't find the order with the given ID.
369
	*/
4283 anupam.sin 370
	bool addBillingDetails(1:i64 orderId, 2:string invoice_number, 3:i64 imeiNumber, 4:string itemNumber, 5:string billed_by, 6:i64 jacketNumber, 7:i64 billingType, 8:i64 vendorId) throws (1:TransactionServiceException ex),
371
 
3060 chandransh 372
	/**
373
	Depending on the third parameter, marks either all prepaid or all cod orders BILLED by the
374
	given warehouse and were picked up by the given provider as SHIPPED_FROM_WH.
375
	*/
376
	bool markOrdersAsManifested(1:i64 warehouseId, 2:i64 providerId, 3:bool cod) throws (1:TransactionServiceException ex),
377
 
378
	/**
1115 chandransh 379
	Marks all SHIPPED_FROM_WH orders of the previous day for a provider as SHIPPED_TO_LOGISTICS.
380
	Returns a list of orders that were shipped from warehouse but did not appear in the pick-up report.
381
	Raises an exception if we encounter report for an AWB number that we did not ship.
382
	*/
1244 chandransh 383
	list<Order> markOrdersAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails) throws (1:TransactionServiceException ex),
1134 chandransh 384
 
385
	/**
386
	Marks all orders with AWBs in the given map as delivered. Also sets the delivery timestamp and
387
	the name of the receiver.
388
	Raises an exception if we encounter report for an AWB number that we did not ship.
389
	*/
390
	void markOrdersAsDelivered(1:i64 providerId, 2:map<string, string> deliveredOrders) throws (1:TransactionServiceException ex),
391
 
392
	/**
393
	Mark all orders with AWBs in the given map as failed. Also sets the delivery timestamp.
394
	Raises an exception if we encounter report for an AWB number that we did not ship.
395
	*/
396
	void markOrdersAsFailed(1:i64 providerId, 2:map<string, string> returnedOrders) throws (1:TransactionServiceException ex),
397
 
1244 chandransh 398
	/**
399
	Update the status description of orders whose AWB numbers are keys of the Map.
400
	*/
401
	void updateNonDeliveryReason(1:i64 providerId, 2:map<string, string> undeliveredOrders) throws (1:TransactionServiceException ex),
402
 
1407 ankur.sing 403
	/**
404
	Returns the list of orders whose delivery time has passed but have not been
405
	delivered yet for the given provider and warehouse. To get a complete list of
406
	undelivered orders, pass them as -1. 
407
	Returns an empty list if no such orders exist.
408
	*/
409
	list<Order> getUndeliveredOrders(1:i64 providerId, 2:i64 warehouseId),
410
 
1599 ankur.sing 411
	/**
2537 chandransh 412
	Toggle the DOA flag of an order. This should be used to flag an order for follow-up and unflag it when the follow-up is complete.
413
	Returns the final flag status.
414
	Throws an exception if the order with the given id couldn't be found or if the order status is not DELVIERY_SUCCESS. 
415
	*/
416
	bool toggleDOAFlag(1:i64 orderId) throws (1:TransactionServiceException ex),
417
 
418
	/**
419
	Sends out an email to the account manager of the original courier provider used to ship the order.
420
	If the order status was DELIVERY_SUCCESS, it is changed to be DOA_PICKUP_REQUESTED.
421
	If the order status was DOA_PICKUP_REQUESTED, it is left unchanged.
422
	For any other status, it returns false.
423
	Throws an exception if the order with the given id couldn't be found.
424
	*/
425
	bool requestPickupNumber(1:i64 orderId) throws (1:TransactionServiceException ex),
426
 
427
	/**
428
	If the order status is DOA_PICKUP_REQUESTED, it does the following
429
		1. Sends out an email to the customer with the dispatch advice that he has to print as an attachment.
430
		2. Changes order status to be DOA_PICKUP_AUTHORIZED.
431
		3. Returns true
2589 chandransh 432
	If the order is in any other status, it returns false.
2537 chandransh 433
	Throws an exception if the order with the given id couldn't be found.
434
	*/
435
	bool authorizePickup(1:i64 orderId, 2:string pickupNumber) throws (1:TransactionServiceException ex),
2589 chandransh 436
 
437
	/**
2765 chandransh 438
	Marks all DOA_PICKUP_AUTHORIZED orders of the previous day for a provider as DOA_RETURN_IN_TRANSIT.
439
	Returns a list of orders that were authorized for pickup but did not appear in the pick-up report.
440
	*/
441
	list<Order> markDoasAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails),
442
 
443
	/**
2600 chandransh 444
	If the order status is DOA_RETURN_AUTHORIZED or DOA_RETURN_IN_TRANSIT, marks the order status as DOA_RECEIVED and returns true.
2614 chandransh 445
	If the order status is SALES_RETURN_IN_TRANSIT, marks the order status as SALES_RET_RECEIVED and returns true.
2589 chandransh 446
	If the order is in any other state, it returns false.
447
	Throws an exception if the order with the given id couldn't be found.
448
	*/
2614 chandransh 449
	bool receiveReturn(1:i64 orderId) throws (1:TransactionServiceException ex),
2589 chandransh 450
 
451
	/**
2600 chandransh 452
	Used to validate the DOA certificate for an order in the DOA_RECEIVED state. If the certificate is valid,
2614 chandransh 453
	the order state is changed to DOA_CERT_VALID. If the certificate is invalid, the order state is changed to DOA_CERT_INVALID.
2589 chandransh 454
	If the order is in any other state, it returns false.
455
	Throws an exception if the order with the given id couldn't be found.
456
	*/
457
	bool validateDoa(1:i64 orderId, 2:bool isValid) throws (1:TransactionServiceException ex),
2614 chandransh 458
 
459
	/**
460
	If the order is in SALES_RET_RECEIVED or DOA_CERT_INVALID state, it does the following:
461
		1. Creates a new order for processing in the BILLED state. All billing information is saved.
462
		2. Marks the current order as one of the final states SALES_RET_RESHIPPED and DOA_INVALID_RESHIPPED depending on what state the order started in.
463
 
464
	If the order is in DOA_CERT_VALID state, it does the following:
465
		1. Creates a new order for processing in the SUBMITTED_FOR_PROCESSING state.
466
		2. Creates a return order for the warehouse executive to return the DOA material.
467
		3. Marks the current order as the final DOA_RESHIPPED state.
468
 
469
	Returns the id of the newly created order.
470
 
471
	Throws an exception if the order with the given id couldn't be found.
472
	*/
473
	i64 reshipOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
474
 
475
	/**
476
	If the order is in SALES_RET_RECEIVED, DOA_CERT_VALID or DOA_CERT_INVALID state, it does the following:
477
		1. Creates a refund request for batch processing.
478
		2. Creates a return order for the warehouse executive to return the shipped material.
479
		3. Marks the current order as SALES_RET_REFUNDED, DOA_VALID_REFUNDED or DOA_INVALID_REFUNDED final states.
480
 
481
	If the order is in SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
482
		1. Creates a refund request for batch processing.
3226 chandransh 483
		2. Cancels the reservation of the item in the warehouse.
484
		3. Marks the current order as the REFUNDED final state.
2614 chandransh 485
 
3226 chandransh 486
	For all COD orders, if the order is in INIT, SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
487
		1. Cancels the reservation of the item in the warehouse.
488
		2. Marks the current order as CANCELED.	
489
 
490
	In all cases, it updates the reason for cancellation or refund and the person who performed the action.
491
 
2614 chandransh 492
	Returns True if it is successful, False otherwise.
493
 
494
	Throws an exception if the order with the given id couldn't be found.
495
	*/
3226 chandransh 496
	bool refundOrder(1:i64 orderId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
2688 chandransh 497
 
498
	/**
499
	Get all return orders created between the from and to dates for the given warehouse.
500
	Ignores the warehouse if it is passed as -1.
501
	*/
502
	list<ReturnOrder> getReturnOrders(1:i64 warehouseId, 2:i64 fromDate, 3:i64 toDate),
503
 
504
	/**
2700 chandransh 505
	Returns the ReturnOrder corresponding to the given id.
506
	Throws an exception if the return order with the given id couldn't be found.
507
	*/
508
	ReturnOrder getReturnOrder(1:i64 id) throws (1:TransactionServiceException ex),
509
 
510
	/**
2688 chandransh 511
	Marks the return order with the given id as processed. Raises an exception if no such return order exists. 
512
	*/
2819 chandransh 513
	void processReturn(1:i64 returnOrderId) throws (1:TransactionServiceException ex),
514
 
515
	/**
516
	Creates a purchase order corresponding to all the pending orders of the given warehouse.
517
	Returns the PO no. of the newly created purchase order. Returns -1 no new purchase order had to be created.
518
	*/
3451 chandransh 519
	i64 createPurchaseOrder(1:i64 warehouseId) throws (1:TransactionServiceException ex),
520
 
521
	/**
522
	Set the weight of the given order to the provided value. Will attempt to update the weight of the item in the catalog as well.
523
	*/
3469 chandransh 524
	Order updateWeight(1:i64 orderId, 2:double weight) throws (1:TransactionServiceException ex),
525
 
526
	/**
527
	Change the item to be shipped for this order. Also adjusts the reservation in the inventory accordingly.
528
	Currently, it also ensures that only a different color of the given item is shipped.
529
	*/
530
	Order changeItem(1:i64 orderId, 2:i64 itemId) throws (1:TransactionServiceException ex),
531
 
532
	/**
533
	Moves the given order to the given warehouse. Also adjusts the inventory reservations accordingly.
534
	*/
3553 chandransh 535
	Order shiftToWarehouse(1:i64 orderId, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
536
 
537
	/**
538
	Adds the given delay reason to the given order.
3986 chandransh 539
	Increases the expected delivery time of the given order by the given no. of days.
3553 chandransh 540
	Raises an exception if no order with the given id can be found.
541
	*/
3986 chandransh 542
	bool addDelayReason(1:i64 orderId, 2:DelayReason delayReason, 3:i64 furtherDelay) throws (1:TransactionServiceException ex),
3956 chandransh 543
 
544
	/**
545
	Marks the COD orders with given AWB nos. as having been processed.
546
	Updates the captured amount for the corresponding payment.
547
 
548
	Returns a map of AWBs which were not processed and the associated reason. An AWB is not processed if:
549
	1. There is no order corresponding to an AWB number.
550
	2. The captured amount for a payment exceeds the total payment.
551
	3. The order corresponding to an AWB no. is in a state prior to DELIVERY_SUCCESS.
552
	*/
4008 mandeep.dh 553
	map<string, string> reconcileCodCollection(1:map<string, double> collectedAmountMap, 2:string xferBy, 3:string xferTxnId, 4:i64 xferDate) throws (1:TransactionServiceException ex),
554
 
555
    /**
4065 mandeep.dh 556
     * Returns the list of transaction ids that require some extra processing and
4008 mandeep.dh 557
     * which belong to a particular category. This is currently used by CRM
4065 mandeep.dh 558
     * application. If no such transaction ids are present, it returns an empty list.
4008 mandeep.dh 559
     */
560
    list<i64> getTransactionsRequiringExtraProcessing(1:ExtraTransactionProcessingType category),
561
 
562
	/**
563
	 * Marks a particular transaction as processed for a particular cateogory.
4065 mandeep.dh 564
	 * It essentially deletes the transaction id record for a particular
565
	 * processing type category (if present) from DB.
566
	 * This is currently used by CRM application.
4008 mandeep.dh 567
	 */
4018 chandransh 568
	void markTransactionAsProcessed(1:i64 transactionId, 2:ExtraTransactionProcessingType category),
569
 
570
	/**
571
	Returns a map containing the number of risky orders keyed by item id. A risky order
572
	is defined as one whose shipping date is about to expire.
573
	*/
4245 rajveer 574
	map<i64, i64> getItemWiseRiskyOrdersCount(),
575
 
576
	/**
4295 varun.gupt 577
	Returns a list of all orders which have items with given id
578
	*/
579
	list<Order> getOrdersForItemIds(1:list<i64> itemIds),
580
 
581
	/**
4245 rajveer 582
	 * Mark order as cancellation request received. If customer sends request of cancellation of 
583
	 * a particular order, this method will be called. It will just change status of the order 
584
	 * depending on its current status. It also records the previous status, so that we can move 
585
	 * back to that status if cancellation request is denied.
586
	 */
587
	void markOrderCancellationRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
588
 
589
	/**
590
	 * If we decide to to cancel order, CRM will call this method to move the status of order to 
591
	 * cancellation request confirmed. After this OM will be able to cancel the order. 	
592
	 */
593
	void markOrderCancellationRequestConfirmed(1:i64 orderId) throws (1:TransactionServiceException ex),
594
 
595
	/**
596
	 * If we decide to not to cancel order, we will move the order ro previous status.	
597
	 */
598
	void markOrderCancellationRequestDenied(1:i64 orderId) throws (1:TransactionServiceException ex),
599
 
600
	/**
4258 rajveer 601
	 * If we and/or payment gateway has decided to accept the payment, this method needs to be called.
602
	 * Changed transaction and all orders status to payment accepted.  
4245 rajveer 603
	 */
4285 rajveer 604
	void markTransactionAsPaymentFlagRemoved(1:i64 transactionId) throws (1:TransactionServiceException ex),
4245 rajveer 605
 
4259 anupam.sin 606
	/**
607
	* This method is called when a flagged payment is deemed unserviceable and the corresponding orders
608
	* need to be cancelled
609
	*/
4285 rajveer 610
	void refundTransaction(1:i64 transactionId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
611
 
612
	/**
613
	Marks the orders as ACCEPTED for the given itemId and inventory. It also updates the accepted timestamp. If the
614
	given order is not a COD order, it also captures the payment if the same has not been captured.
615
	*/
4303 rajveer 616
	bool acceptOrdersForItemId(1:i64 itemId, 2:i64 inventory) throws (1:TransactionServiceException ex),
4285 rajveer 617
 
4303 rajveer 618
	void markOrdersAsPORaised(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate) throws (1:TransactionServiceException ex),
619
	void markOrdersAsReversalInitiated(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate) throws (1:TransactionServiceException ex),
620
	void markOrdersAsNotAvailabke(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate) throws (1:TransactionServiceException ex)
4285 rajveer 621
 
4303 rajveer 622
 
623
 
1115 chandransh 624
}