Subversion Repositories SmartDukaan

Rev

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