Subversion Repositories SmartDukaan

Rev

Rev 4486 | Rev 4495 | 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,
210
	48:i64 vendorId
483 rajveer 211
}
212
 
4245 rajveer 213
struct OrderStatusAuditTrail{
214
	1:i64 id,
215
	2:i64 orderId,
216
	3:i64 status,
217
	4:i64 timestamp,
218
	5:i64 description
219
}
220
 
483 rajveer 221
struct Transaction{
222
	1:i64 id,
223
	2:list<Order> orders,
680 rajveer 224
	3:i64 createdOn,
225
	4:TransactionStatus transactionStatus,
226
	5:string statusDescription,
227
	6:i64 shoppingCartid,
2219 varun.gupt 228
	7:i64 customer_id,
2814 vikas 229
	8:string coupon_code,
230
	9:string sessionSource,
3858 vikas 231
	10:i64 sessionStartTime,
232
	11:string firstSource,
233
    12:i64 firstSourceTime
483 rajveer 234
}
235
 
4393 rajveer 236
enum AlertType{
237
	NEW_INVENTORY_ALERT,
238
	ORDER_READY_TO_ACCEPT
239
}
240
 
483 rajveer 241
struct Alert{
242
	1:i64 id,
4393 rajveer 243
	2:AlertType type,
244
	3:i64 status,
245
	4:i64 timestamp,
246
	5:string description
4444 rajveer 247
	6:i64 warehouseId
483 rajveer 248
}
249
 
2688 chandransh 250
struct ReturnOrder{
251
	1:i64 orderId,
2697 chandransh 252
	2:i64 warehouseId,
253
    3:i64 jacketNumber,
254
    4:string invoiceNumber,
255
    5:i64 itemId,
256
    6:string productGroup,
257
    7:string brand,
258
    8:string modelNumber,
259
    9:string modelName,
260
    10:string color,
261
    11:double totalPrice,
262
    12:double transferPrice,
263
    13:bool processedStatus,
264
    14:i64 createdAt,
265
    15:i64 processedAt
2688 chandransh 266
}
267
 
4303 rajveer 268
enum HotspotAction{
269
	PO_RAISED,
270
	REVERSAL_INITIATED,
271
	NOT_AVAILABLE
272
}
273
 
4369 rajveer 274
struct TimeoutSummary{
275
	1:i32 poRaised,
276
	2:i32 poEstimate
277
	3:i32 reversalInitiated,
278
	4:i32 reversalEstimate
279
}
280
 
483 rajveer 281
exception TransactionServiceException{
282
	1:i32 errorCode,
283
	2:string message
284
}
285
 
3374 rajveer 286
service TransactionService extends GenericService.GenericService{
483 rajveer 287
 
288
	i64 createTransaction(1:Transaction transaction) throws (1:TransactionServiceException ex),
289
 
290
	//	Get transaction methods.
291
	Transaction getTransaction(1:i64 id) throws (1:TransactionServiceException ex),
292
	list<Transaction> getTransactionsForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:TransactionStatus status) throws (1:TransactionServiceException ex),
293
	list<Transaction> getTransactionsForShoppingCartId(1:i64 shoppingCartId) throws (1:TransactionServiceException ex),
294
	TransactionStatus getTransactionStatus(1:i64 transactionId) throws (1:TransactionServiceException ex),
295
	bool changeTransactionStatus(1:i64 transactionId, 2:TransactionStatus status, 3:string description) throws (1:TransactionServiceException ex),
1382 varun.gupt 296
 
1398 varun.gupt 297
	bool enqueueTransactionInfoEmail(1:i64 transactionId) throws (1:TransactionServiceException ex),
1382 varun.gupt 298
 
483 rajveer 299
	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 300
 
1115 chandransh 301
	/**
4133 chandransh 302
	Returns at most 'limit' orders with the given statuses for the given warehouse starting from the given offset.
303
	Pass the status as null and the limit as 0 to ignore them.
304
	*/
305
	list<Order> getOrdersInBatch(1:list<OrderStatus> statuses, 2:i64 offset, 3:i64 limit, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
306
 
307
	/**
308
	Returns the count of orders with the given statuses assigned to the given warehouse.
309
	*/
310
	i32 getOrderCount(1:list<OrderStatus> statuses, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
311
 
312
	/**
1115 chandransh 313
	Returns orders within a range of their billing dates
314
	*/
1000 varun.gupt 315
	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 316
 
1382 varun.gupt 317
	/**
3427 chandransh 318
	Returns orders for a particular provider and warehouse which were shipped between the given dates.
3451 chandransh 319
	Returned orders comprise of COD orders if cod parameter is true. It comprises of prepaid orders otherwise. 
320
	Pass providerId and warehouseId as -1 to ignore both these parameters.
3427 chandransh 321
	*/
3451 chandransh 322
	list<Order> getOrdersByShippingDate(1:i64 fromShippingDate, 2:i64 toShippingDate, 3:i64 providerId, 4:i64 warehouseId, 5:bool cod) throws (1:TransactionServiceException ex),
3427 chandransh 323
 
324
	/**
1382 varun.gupt 325
	Returns order ids for orders which can be returned
326
	*/
327
	list<i64> getReturnableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
328
 
329
	/**
330
	Returns order ids for orders which can be cancelled
331
	*/
332
	list<i64> getCancellableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
333
 
483 rajveer 334
	bool changeOrderStatus(1:i64 orderId, 2:OrderStatus status, 3:string description) throws (1:TransactionServiceException ex),
1147 chandransh 335
 
336
	/**
1529 ankur.sing 337
	Returns list of orders for given transaction Id. Also filters based on customer Id so that
338
	only user who owns the transaction can view its order details.
339
	*/
340
	list<Order> getOrdersForTransaction(1:i64 transactionId 2:i64 customerId)  throws (1:TransactionServiceException ex),
3014 chandransh 341
 
342
	/**
343
	Returns list of orders for the given customer created between the given dates and having the given statuses.
344
	Pass and empty list to ignore filtering on statuses.
345
	*/	
346
	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 347
 
483 rajveer 348
	i64 createOrder(1:Order order) throws (1:TransactionServiceException ex),
349
	Order getOrder(1:i64 id) throws (1:TransactionServiceException ex),
350
	list<LineItem> getLineItemsForOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
351
 
1529 ankur.sing 352
 
757 chandransh 353
	/**
1529 ankur.sing 354
	Returns an order for the order Id. Also checks if the order belongs to the customer whose Id is passed.
355
	Throws exception if either order Id is invalid or order does not below to the customer whose Id is passed.
356
	*/
357
	Order getOrderForCustomer(1:i64 orderId, 2:i64 customerId) throws (1:TransactionServiceException ex),
358
 
3060 chandransh 359
	//Alerts apis 
4444 rajveer 360
	list<Alert> getAlerts(1:i64 type, 2:i64 warehouseId, 3:i64 status, 4:i64 timestamp),
361
	void addAlert(1:i64 type, 2:i64 warehouseId, 3:string description),
362
	void markAlertsAsSeen(1:i64 warehouseId),
3060 chandransh 363
 
1529 ankur.sing 364
	/**
3060 chandransh 365
	Return the number of valid orders. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
366
	*/
367
	i64 getValidOrderCount(),
368
 
369
	/**
370
	Returns the number of distinct customers who have done successful transactions
371
	*/
372
	i64 getNoOfCustomersWithSuccessfulTransaction(),
373
 
374
	/**
375
	Returns the minimum and maximum amounts of a valid order. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
376
	List contains two values, first minimum amount and second maximum amount.	
377
	*/
378
	list<double> getValidOrdersAmountRange(),
379
 
380
	/**
381
	Returns list of Orders in descending order by Order creation date. List is restricted to limit Orders.
382
	If limit is passed as 0, then all valid Orders are returned. 
383
	*/
384
	list<Order> getValidOrders(1:i64 limit),
385
 
386
	/**
387
	Create a batch of all the pending orders for the given warehouse.
388
	The returned list is orderd by created_timestamp.
389
	If there are no pending orders, an empty list is returned.
390
	*/
1223 chandransh 391
	list<Order> batchOrders(1:i64 warehouseId) throws (1:TransactionServiceException ex),
392
 
393
	/**
394
	Mark the given order as out of stock. Throws an exception if the order with the given Id couldn't be found. 
1244 chandransh 395
	*/
1210 chandransh 396
	bool markOrderAsOutOfStock(1:i64 orderId) throws (1:TransactionServiceException ex),
397
 
398
	/**
3060 chandransh 399
	Marks the given order as SUBMITTED_FOR_PROCESSING and updates the verified
400
	timestamp. It is intended to be used for COD orders but can be harmlessly 
401
	used for all other orders as well.
402
	Throws an exception if no such order exists.
757 chandransh 403
	*/
3060 chandransh 404
	bool verifyOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
1115 chandransh 405
 
406
	/**
3060 chandransh 407
	Marks the given order as ACCEPTED and updates the accepted timestamp. If the
408
	given order is not a COD order, it also captures the payment if the same has
409
	not been captured.
410
	Throws an exception if no such order exists.
411
	*/
412
	bool acceptOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
413
 
414
	/**
415
	Add billing details such as the bill number and the biller to the Order.
416
	Adds jacket number, item number and IMEI no. to the order. Doesn't update
417
	the IMEI no. if a -1 is supplied.
418
	Also, it generates an invoice number for the order, marks the order as
419
	BILLED and sets the billing timestamp.
420
	Returns false if it doesn't find the order with the given ID.
421
	*/
4283 anupam.sin 422
	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),
423
 
3060 chandransh 424
	/**
425
	Depending on the third parameter, marks either all prepaid or all cod orders BILLED by the
4410 rajveer 426
	given warehouse and were picked up by the given provider as MANIFESTED.
3060 chandransh 427
	*/
428
	bool markOrdersAsManifested(1:i64 warehouseId, 2:i64 providerId, 3:bool cod) throws (1:TransactionServiceException ex),
4410 rajveer 429
 
3060 chandransh 430
	/**
4410 rajveer 431
	Depending on the third parameter, marks either all prepaid or all cod orders BILLED and marked as MANIFESTED by the
432
	given warehouse and were picked up by the given provider as SHIPPED_FROM_WH.
433
	*/
434
	bool markOrdersAsShippedFromWarehouse(1:i64 warehouseId, 2:i64 providerId, 3:bool cod) throws (1:TransactionServiceException ex),
435
 
436
	/**
1115 chandransh 437
	Marks all SHIPPED_FROM_WH orders of the previous day for a provider as SHIPPED_TO_LOGISTICS.
438
	Returns a list of orders that were shipped from warehouse but did not appear in the pick-up report.
439
	Raises an exception if we encounter report for an AWB number that we did not ship.
440
	*/
1244 chandransh 441
	list<Order> markOrdersAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails) throws (1:TransactionServiceException ex),
1134 chandransh 442
 
443
	/**
444
	Marks all orders with AWBs in the given map as delivered. Also sets the delivery timestamp and
445
	the name of the receiver.
446
	Raises an exception if we encounter report for an AWB number that we did not ship.
447
	*/
448
	void markOrdersAsDelivered(1:i64 providerId, 2:map<string, string> deliveredOrders) throws (1:TransactionServiceException ex),
449
 
450
	/**
451
	Mark all orders with AWBs in the given map as failed. Also sets the delivery timestamp.
452
	Raises an exception if we encounter report for an AWB number that we did not ship.
453
	*/
454
	void markOrdersAsFailed(1:i64 providerId, 2:map<string, string> returnedOrders) throws (1:TransactionServiceException ex),
455
 
1244 chandransh 456
	/**
457
	Update the status description of orders whose AWB numbers are keys of the Map.
458
	*/
459
	void updateNonDeliveryReason(1:i64 providerId, 2:map<string, string> undeliveredOrders) throws (1:TransactionServiceException ex),
460
 
1407 ankur.sing 461
	/**
462
	Returns the list of orders whose delivery time has passed but have not been
463
	delivered yet for the given provider and warehouse. To get a complete list of
464
	undelivered orders, pass them as -1. 
465
	Returns an empty list if no such orders exist.
466
	*/
467
	list<Order> getUndeliveredOrders(1:i64 providerId, 2:i64 warehouseId),
468
 
1599 ankur.sing 469
	/**
2537 chandransh 470
	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.
471
	Returns the final flag status.
472
	Throws an exception if the order with the given id couldn't be found or if the order status is not DELVIERY_SUCCESS. 
473
	*/
474
	bool toggleDOAFlag(1:i64 orderId) throws (1:TransactionServiceException ex),
475
 
476
	/**
4454 rajveer 477
	 Once user raise the request for a DOA, order status will be changed from DELVIERY_SUCCESS to DOA_REQUEST_RECEIVED 
478
	*/
479
	bool markOrderDoaRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
480
 
481
	/**
482
	 CRM person can authorize or deny the request reised by customer. If he authorizes order will change from DOA_REQUEST_RECEIVED 
483
	 to DOA_REQUEST_AUTHORIZED. If he denies, status will be changed back to DELVIERY_SUCCESS. 
484
	*/
485
	bool markOrderDoaRequestAuthorized(1:i64 orderId, 2:bool isAuthorized) throws (1:TransactionServiceException ex),
486
 
487
	/**
4488 rajveer 488
	 Once user raise the request for a RET, order status will be changed from DELVIERY_SUCCESS to RET_REQUEST_RECEIVED 
489
	*/
490
	bool markOrderReturnRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
491
 
492
	/**
493
	 CRM person can authorize or deny the request reised by customer. If he authorizes order will change from RET_REQUEST_RECEIVED 
494
	 to RET_REQUEST_AUTHORIZED. If he denies, status will be changed back to DELVIERY_SUCCESS. 
495
	*/
496
	bool markOrderReturnRequestAuthorized(1:i64 orderId, 2:bool isAuthorized) throws (1:TransactionServiceException ex),
497
 
498
	/**
2537 chandransh 499
	Sends out an email to the account manager of the original courier provider used to ship the order.
4452 rajveer 500
	If the order status was DELIVERY_SUCCESS, it is changed to be DOA_PICKUP_REQUEST_RAISED.
501
	If the order status was DOA_PICKUP_REQUEST_RAISED, it is left unchanged.
2537 chandransh 502
	For any other status, it returns false.
503
	Throws an exception if the order with the given id couldn't be found.
504
	*/
505
	bool requestPickupNumber(1:i64 orderId) throws (1:TransactionServiceException ex),
506
 
507
	/**
4452 rajveer 508
	If the order status is DOA_PICKUP_REQUEST_RAISED, it does the following
2537 chandransh 509
		1. Sends out an email to the customer with the dispatch advice that he has to print as an attachment.
510
		2. Changes order status to be DOA_PICKUP_AUTHORIZED.
511
		3. Returns true
2589 chandransh 512
	If the order is in any other status, it returns false.
2537 chandransh 513
	Throws an exception if the order with the given id couldn't be found.
514
	*/
515
	bool authorizePickup(1:i64 orderId, 2:string pickupNumber) throws (1:TransactionServiceException ex),
2589 chandransh 516
 
517
	/**
2765 chandransh 518
	Marks all DOA_PICKUP_AUTHORIZED orders of the previous day for a provider as DOA_RETURN_IN_TRANSIT.
519
	Returns a list of orders that were authorized for pickup but did not appear in the pick-up report.
520
	*/
521
	list<Order> markDoasAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails),
522
 
523
	/**
4452 rajveer 524
	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 525
	If the order status is RTO_IN_TRANSIT, marks the order status as RTO_RECEIVED_PRESTINE and returns true.
2589 chandransh 526
	If the order is in any other state, it returns false.
527
	Throws an exception if the order with the given id couldn't be found.
528
	*/
4478 rajveer 529
	bool receiveReturn(1:i64 orderId, 2:i64 receiveCondition) throws (1:TransactionServiceException ex),
2589 chandransh 530
 
531
	/**
4452 rajveer 532
	Used to validate the DOA certificate for an order in the DOA_RECEIVED_PRESTINE state. If the certificate is valid,
2614 chandransh 533
	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 534
	If the order is in any other state, it returns false.
535
	Throws an exception if the order with the given id couldn't be found.
536
	*/
537
	bool validateDoa(1:i64 orderId, 2:bool isValid) throws (1:TransactionServiceException ex),
2614 chandransh 538
 
539
	/**
4484 rajveer 540
	If the order is in RTO_RECEIVED_PRESTINE or DOA_CERT_INVALID state, it does the following:
2614 chandransh 541
		1. Creates a new order for processing in the BILLED state. All billing information is saved.
4484 rajveer 542
		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 543
 
544
	If the order is in DOA_CERT_VALID state, it does the following:
545
		1. Creates a new order for processing in the SUBMITTED_FOR_PROCESSING state.
546
		2. Creates a return order for the warehouse executive to return the DOA material.
4452 rajveer 547
		3. Marks the current order as the final DOA_VALID_RESHIPPED state.
2614 chandransh 548
 
549
	Returns the id of the newly created order.
550
 
551
	Throws an exception if the order with the given id couldn't be found.
552
	*/
553
	i64 reshipOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
554
 
555
	/**
4484 rajveer 556
	If the order is in RTO_RECEIVED_PRESTINE, DOA_CERT_VALID or DOA_CERT_INVALID state, it does the following:
2614 chandransh 557
		1. Creates a refund request for batch processing.
558
		2. Creates a return order for the warehouse executive to return the shipped material.
4484 rajveer 559
		3. Marks the current order as RTO_REFUNDED, DOA_VALID_REFUNDED or DOA_INVALID_REFUNDED final states.
2614 chandransh 560
 
561
	If the order is in SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
562
		1. Creates a refund request for batch processing.
3226 chandransh 563
		2. Cancels the reservation of the item in the warehouse.
564
		3. Marks the current order as the REFUNDED final state.
2614 chandransh 565
 
3226 chandransh 566
	For all COD orders, if the order is in INIT, SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
567
		1. Cancels the reservation of the item in the warehouse.
568
		2. Marks the current order as CANCELED.	
569
 
570
	In all cases, it updates the reason for cancellation or refund and the person who performed the action.
571
 
2614 chandransh 572
	Returns True if it is successful, False otherwise.
573
 
574
	Throws an exception if the order with the given id couldn't be found.
575
	*/
3226 chandransh 576
	bool refundOrder(1:i64 orderId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
2688 chandransh 577
 
578
	/**
579
	Get all return orders created between the from and to dates for the given warehouse.
580
	Ignores the warehouse if it is passed as -1.
581
	*/
582
	list<ReturnOrder> getReturnOrders(1:i64 warehouseId, 2:i64 fromDate, 3:i64 toDate),
583
 
584
	/**
2700 chandransh 585
	Returns the ReturnOrder corresponding to the given id.
586
	Throws an exception if the return order with the given id couldn't be found.
587
	*/
588
	ReturnOrder getReturnOrder(1:i64 id) throws (1:TransactionServiceException ex),
589
 
590
	/**
2688 chandransh 591
	Marks the return order with the given id as processed. Raises an exception if no such return order exists. 
592
	*/
2819 chandransh 593
	void processReturn(1:i64 returnOrderId) throws (1:TransactionServiceException ex),
594
 
595
	/**
596
	Creates a purchase order corresponding to all the pending orders of the given warehouse.
597
	Returns the PO no. of the newly created purchase order. Returns -1 no new purchase order had to be created.
598
	*/
3451 chandransh 599
	i64 createPurchaseOrder(1:i64 warehouseId) throws (1:TransactionServiceException ex),
600
 
601
	/**
602
	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.
603
	*/
3469 chandransh 604
	Order updateWeight(1:i64 orderId, 2:double weight) throws (1:TransactionServiceException ex),
605
 
606
	/**
607
	Change the item to be shipped for this order. Also adjusts the reservation in the inventory accordingly.
608
	Currently, it also ensures that only a different color of the given item is shipped.
609
	*/
610
	Order changeItem(1:i64 orderId, 2:i64 itemId) throws (1:TransactionServiceException ex),
611
 
612
	/**
613
	Moves the given order to the given warehouse. Also adjusts the inventory reservations accordingly.
614
	*/
3553 chandransh 615
	Order shiftToWarehouse(1:i64 orderId, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
616
 
617
	/**
618
	Adds the given delay reason to the given order.
3986 chandransh 619
	Increases the expected delivery time of the given order by the given no. of days.
3553 chandransh 620
	Raises an exception if no order with the given id can be found.
621
	*/
3986 chandransh 622
	bool addDelayReason(1:i64 orderId, 2:DelayReason delayReason, 3:i64 furtherDelay) throws (1:TransactionServiceException ex),
3956 chandransh 623
 
624
	/**
625
	Marks the COD orders with given AWB nos. as having been processed.
626
	Updates the captured amount for the corresponding payment.
627
 
628
	Returns a map of AWBs which were not processed and the associated reason. An AWB is not processed if:
629
	1. There is no order corresponding to an AWB number.
630
	2. The captured amount for a payment exceeds the total payment.
631
	3. The order corresponding to an AWB no. is in a state prior to DELIVERY_SUCCESS.
632
	*/
4008 mandeep.dh 633
	map<string, string> reconcileCodCollection(1:map<string, double> collectedAmountMap, 2:string xferBy, 3:string xferTxnId, 4:i64 xferDate) throws (1:TransactionServiceException ex),
634
 
635
    /**
4065 mandeep.dh 636
     * Returns the list of transaction ids that require some extra processing and
4008 mandeep.dh 637
     * which belong to a particular category. This is currently used by CRM
4065 mandeep.dh 638
     * application. If no such transaction ids are present, it returns an empty list.
4008 mandeep.dh 639
     */
640
    list<i64> getTransactionsRequiringExtraProcessing(1:ExtraTransactionProcessingType category),
641
 
642
	/**
643
	 * Marks a particular transaction as processed for a particular cateogory.
4065 mandeep.dh 644
	 * It essentially deletes the transaction id record for a particular
645
	 * processing type category (if present) from DB.
646
	 * This is currently used by CRM application.
4008 mandeep.dh 647
	 */
4018 chandransh 648
	void markTransactionAsProcessed(1:i64 transactionId, 2:ExtraTransactionProcessingType category),
649
 
650
	/**
651
	Returns a map containing the number of risky orders keyed by item id. A risky order
652
	is defined as one whose shipping date is about to expire.
653
	*/
4245 rajveer 654
	map<i64, i64> getItemWiseRiskyOrdersCount(),
655
 
656
	/**
4295 varun.gupt 657
	Returns a list of all orders which have items with given id
658
	*/
659
	list<Order> getOrdersForItemIds(1:list<i64> itemIds),
660
 
661
	/**
4245 rajveer 662
	 * Mark order as cancellation request received. If customer sends request of cancellation of 
663
	 * a particular order, this method will be called. It will just change status of the order 
664
	 * depending on its current status. It also records the previous status, so that we can move 
665
	 * back to that status if cancellation request is denied.
666
	 */
667
	void markOrderCancellationRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
668
 
669
	/**
670
	 * If we decide to to cancel order, CRM will call this method to move the status of order to 
671
	 * cancellation request confirmed. After this OM will be able to cancel the order. 	
672
	 */
673
	void markOrderCancellationRequestConfirmed(1:i64 orderId) throws (1:TransactionServiceException ex),
674
 
675
	/**
676
	 * If we decide to not to cancel order, we will move the order ro previous status.	
677
	 */
678
	void markOrderCancellationRequestDenied(1:i64 orderId) throws (1:TransactionServiceException ex),
679
 
680
	/**
4258 rajveer 681
	 * If we and/or payment gateway has decided to accept the payment, this method needs to be called.
682
	 * Changed transaction and all orders status to payment accepted.  
4245 rajveer 683
	 */
4285 rajveer 684
	void markTransactionAsPaymentFlagRemoved(1:i64 transactionId) throws (1:TransactionServiceException ex),
4245 rajveer 685
 
4259 anupam.sin 686
	/**
687
	* This method is called when a flagged payment is deemed unserviceable and the corresponding orders
688
	* need to be cancelled
689
	*/
4285 rajveer 690
	void refundTransaction(1:i64 transactionId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
4324 mandeep.dh 691
 
692
	/**
693
	 * Updates shipment address of an order. Delivery and shipping date estimates
694
	 * etc. are also updated here.
695
	 *
696
	 * Throws TransactionServiceException in case address change is not
697
	 * possible due to certain reasons such as new pincode in address is
698
	 * not serviceable etc.
699
	 */
700
	void updateShipmentAddress(1:i64 orderId, 2:i64 addressId) throws (1:TransactionServiceException ex)
4285 rajveer 701
 
702
	/**
703
	Marks the orders as ACCEPTED for the given itemId and inventory. It also updates the accepted timestamp. If the
704
	given order is not a COD order, it also captures the payment if the same has not been captured.
705
	*/
4303 rajveer 706
	bool acceptOrdersForItemId(1:i64 itemId, 2:i64 inventory) throws (1:TransactionServiceException ex),
4285 rajveer 707
 
4369 rajveer 708
	void markOrdersAsPORaised(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
709
	void markOrdersAsReversalInitiated(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
710
	void markOrdersAsNotAvailabke(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
711
 
4386 anupam.sin 712
	map<i32, TimeoutSummary> markOrdersAsTimeout(1:i64 vendorId) throws (1:TransactionServiceException ex),
4369 rajveer 713
 
4386 anupam.sin 714
	/**
715
	Returns the order corresponding to an AWB number
716
	*/
717
	Order getOrderForAwb(1:string awb) throws (1:TransactionServiceException ex)
4369 rajveer 718
 
1115 chandransh 719
}