Subversion Repositories SmartDukaan

Rev

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