Subversion Repositories SmartDukaan

Rev

Rev 7151 | Rev 7172 | 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,
4661 rajveer 12
	COD_VERIFICATION_PENDING,
483 rajveer 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,
4910 phani.kuma 26
	SHIPPED_TO_DESTINATION_CITY,
27
	REACHED_DESTINATION_CITY,
4682 rajveer 28
	COD_VERIFICATION_FAILED,
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,
4682 rajveer 44
	CANCELLED_DUE_TO_LOW_INVENTORY,
4303 rajveer 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,
4910 phani.kuma 50
	FIRST_DELIVERY_ATTEMPT_MADE,
4452 rajveer 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,
4661 rajveer 86
	RET_REFUNDED_LOST_IN_TRANSIT,
87
	LOST_IN_TRANSIT,
88
	LOST_IN_TRANSIT_RESHIPPED,
5553 rajveer 89
	LOST_IN_TRANSIT_REFUNDED,
90
	DELIVERED_AT_STORE,
91
	RECEIVED_AT_STORE
483 rajveer 92
}
93
 
94
enum TransactionStatus{
95
	INIT,
96
	IN_PROCESS,
97
	COMPLETED,
2964 chandransh 98
	FAILED,
3060 chandransh 99
	AUTHORIZED,
4245 rajveer 100
	COD_IN_PROCESS,
101
	FLAGGED
483 rajveer 102
}
103
 
5527 anupam.sin 104
enum OrderType{
6055 rajveer 105
	B2C,
106
	B2Cbulk,
107
	B2B,
7096 anupam.sin 108
	RECHARGE,
109
	RCH4HOTSPOT,
110
	WALLETCREDIT
5527 anupam.sin 111
}
112
 
4008 mandeep.dh 113
enum ExtraTransactionProcessingType {
114
    COD_VERIFICATION,
4245 rajveer 115
    DELAYED_DELIVERY,
6104 rajveer 116
    PAYMENT_FLAGGED,
117
    RECHARGE_UNKNOWN
4008 mandeep.dh 118
}
119
 
6289 anupam.sin 120
enum DenominationType {
121
	TOPUP = 1,
122
    SPECIAL = 2,
123
    DATA = 3
124
}
125
 
483 rajveer 126
struct LineItem{
127
	1:i64 id,
698 chandransh 128
	2:i64 item_id,
4008 mandeep.dh 129
	3:string productGroup,
956 chandransh 130
	4:string brand,
131
	5:string model_number,
4586 mandeep.dh 132
	6:string color,
956 chandransh 133
	7:string model_name,
134
	8:string extra_info,
135
	9:double quantity,
136
	10:double unit_price,
137
	11:double unit_weight,
138
	12:double total_price,
1000 varun.gupt 139
	13:double transfer_price,
2780 chandransh 140
	14:double total_weight,
4658 mandeep.dh 141
	15:optional string serial_number,
4172 rajveer 142
	16:optional string item_number,
4295 varun.gupt 143
	17:optional string dealText,
6039 amit.gupta 144
	18:i64 warrantry_expiry_timestamp,
145
	19:double vatRate
483 rajveer 146
}
147
 
3553 chandransh 148
enum DelayReason {
149
	INVENTORY_LOW_PHASED_OUT,
150
	INVENTORY_LOW_COLOR_NOT_AVAILABLE,
151
	INVENTORY_LOW_REVERSAL_NOT_ON_TIME,
152
	INVENTORY_LOW_PRODUCT_NOT_SEALED,
153
	COURIER_DELAY_NOT_DELIVERED_TO_COURIER_ON_TIME,
154
	COURIER_DELAY_DID_NOT_CONNECT,
155
	COURIER_DELAY_CUSTOMER_NOT_AVAILABLE,
156
	COURIER_DELAY_INCORRECT_ADDRESS
157
	COURIER_DELAY_OCTROI_DELAY,
158
	COURIER_DELAY_FORCES_OF_NATURE,
159
	COD_VERIFICATION_DELAY,
160
	PAYMENT_FLAGGED,
161
	OTHERS
162
}
483 rajveer 163
 
164
struct Order{
165
	1:i64 id,
166
	2:i64 warehouse_id,
167
	/**
168
		item info
169
	**/
170
	3:list<LineItem> lineitems,
171
	/**
172
	  logistics info
173
	**/
174
	4:i64 logistics_provider_id,
175
	5:string airwaybill_no,
176
	6:string tracking_id,
177
	7:i64 expected_delivery_time,
178
	/**
179
	  customer info
180
	**/
181
	8:i64 customer_id,
182
	9:string customer_name,
183
	10:string customer_mobilenumber,
184
	11:string customer_pincode,
735 chandransh 185
	12:string customer_address1,
186
	13:string customer_address2,
187
	14:string customer_email,
188
	15:string customer_city,
189
	16:string customer_state,
483 rajveer 190
 
191
	/**
192
		status and misc info
193
	**/
735 chandransh 194
	17:OrderStatus status,
195
	18:string statusDescription,
196
	19:double total_amount,
197
	20:double total_weight,
483 rajveer 198
	/**
199
		billing info
200
	**/
735 chandransh 201
	21:string invoice_number,
202
	22:string billed_by,
483 rajveer 203
	/**
204
		timestamps
205
	**/
735 chandransh 206
	23:i64 created_timestamp,
207
	24:i64 accepted_timestamp,
208
	25:i64 billing_timestamp,
209
	26:i64 shipping_timestamp,
1115 chandransh 210
	27:i64 pickup_timestamp,
211
	28:i64 delivery_timestamp,
1210 chandransh 212
	29:i64 outofstock_timestamp,
213
	30:i64 jacket_number,
1223 chandransh 214
	31:string receiver,
215
	32:i64 batchNo,
2537 chandransh 216
	33:i64 serialNo,
217
	34:bool doaFlag,
2675 vikas 218
	35:string pickupRequestNo,
2819 chandransh 219
	36:i64 transactionId,
3060 chandransh 220
	37:string purchaseOrderNo,
3553 chandransh 221
	38:bool cod,
4004 chandransh 222
	39:DelayReason delayReason,
223
	40:i64 promised_delivery_time,
224
	41:i64 expected_shipping_time,
4102 chandransh 225
	42:i64 verification_timestamp,
4192 anupam.sin 226
	43:i64 promised_shipping_time,
227
	44:optional i64 reship_timestamp,
228
	45:optional i64 refund_timestamp,
4245 rajveer 229
	46:optional i64 new_order_id,
4269 anupam.sin 230
	47:OrderStatus previousStatus,
4506 phani.kuma 231
	48:i64 vendorId,
4647 rajveer 232
	49:optional i64 doa_auth_timestamp,
4709 rajveer 233
	50:string delayReasonText,
4758 mandeep.dh 234
	51:string refundReason,
4815 phani.kuma 235
	52:i64 purchaseOrderId,
5062 varun.gupt 236
	53:optional i64 doa_logistics_provider_id,
5110 mandeep.dh 237
	54:i64 originalOrderId,
5189 varun.gupt 238
	55:i64 fulfilmentWarehouseId,
5354 anupam.sin 239
	56:bool vendorPaid,
240
	57:optional i64 received_return_timestamp,
5527 anupam.sin 241
	58:optional i64 first_attempt_timestamp,
5553 rajveer 242
	59:OrderType orderType,
243
	60:i64 pickupStoreId,
6318 rajveer 244
	61:bool logisticsCod,
6525 rajveer 245
	62:i64 gvAmount,
6726 rajveer 246
	63:bool otg,
247
	64:i64 courier_delivery_time
6903 anupam.sin 248
	65:i64 insurer,
249
	66:double insuranceAmount,
250
	67:string dob,
251
	68:string guardianName
483 rajveer 252
}
253
 
5527 anupam.sin 254
struct Attribute{
255
	1:string name,
256
	2:string value
257
}
258
 
4245 rajveer 259
struct OrderStatusAuditTrail{
260
	1:i64 id,
261
	2:i64 orderId,
262
	3:i64 status,
263
	4:i64 timestamp,
264
	5:i64 description
265
}
266
 
483 rajveer 267
struct Transaction{
268
	1:i64 id,
269
	2:list<Order> orders,
680 rajveer 270
	3:i64 createdOn,
271
	4:TransactionStatus transactionStatus,
272
	5:string statusDescription,
273
	6:i64 shoppingCartid,
2219 varun.gupt 274
	7:i64 customer_id,
2814 vikas 275
	8:string coupon_code,
276
	9:string sessionSource,
3858 vikas 277
	10:i64 sessionStartTime,
278
	11:string firstSource,
6389 rajveer 279
    12:i64 firstSourceTime,
280
    13:i64 emiSchemeId
483 rajveer 281
}
282
 
4393 rajveer 283
enum AlertType{
284
	NEW_INVENTORY_ALERT,
285
	ORDER_READY_TO_ACCEPT
286
}
287
 
483 rajveer 288
struct Alert{
289
	1:i64 id,
4393 rajveer 290
	2:AlertType type,
291
	3:i64 status,
292
	4:i64 timestamp,
293
	5:string description
4444 rajveer 294
	6:i64 warehouseId
483 rajveer 295
}
296
 
2688 chandransh 297
struct ReturnOrder{
298
	1:i64 orderId,
2697 chandransh 299
	2:i64 warehouseId,
300
    3:i64 jacketNumber,
301
    4:string invoiceNumber,
302
    5:i64 itemId,
303
    6:string productGroup,
304
    7:string brand,
305
    8:string modelNumber,
306
    9:string modelName,
307
    10:string color,
308
    11:double totalPrice,
309
    12:double transferPrice,
310
    13:bool processedStatus,
311
    14:i64 createdAt,
312
    15:i64 processedAt
2688 chandransh 313
}
314
 
4600 varun.gupt 315
struct PaymentSettlement	{
316
    2:i64 paymentGatewayId,
4905 varun.gupt 317
    3:i64 referenceId,
4600 varun.gupt 318
    4:i64 settlementDate,
319
    5:double serviceTax,
320
    6:double otherCharges,
321
    7:double netCollection
322
}
323
 
4875 varun.gupt 324
struct CODPaymentSettlement	{
325
    1:i64 orderId,
326
    2:i64 settlementDate,
327
    3:double collection
328
}
329
 
4303 rajveer 330
enum HotspotAction{
331
	PO_RAISED,
332
	REVERSAL_INITIATED,
333
	NOT_AVAILABLE
334
}
335
 
4369 rajveer 336
struct TimeoutSummary{
337
	1:i32 poRaised,
338
	2:i32 poEstimate
339
	3:i32 reversalInitiated,
340
	4:i32 reversalEstimate
341
}
342
 
5447 anupam.sin 343
struct CODVerificationAgent{
344
	1:i64 orderId,
345
	2:string agentEmailId
346
}
347
 
6000 mandeep.dh 348
enum RechargeType {
349
    MOBILE = 1,
350
    DTH = 2
351
}
352
 
353
enum RechargeOrderStatus {
354
    PAYMENT_PENDING = 1,
6031 rajveer 355
    PAYMENT_FAILED = 2,
356
    PAYMENT_SUCCESSFUL = 3,
6000 mandeep.dh 357
    RECHARGE_FAILED = 4,
6235 rajveer 358
    RECHARGE_SUCCESSFUL = 5,
6507 anupam.sin 359
    RECHARGE_FAILED_REFUNDED = 6,
360
    REFUNDED = 7,
7073 anupam.sin 361
    PARTIALLY_REFUNDED = 8,
362
    INIT = 9,
363
    RECHARGE_UNKNOWN = 10
6000 mandeep.dh 364
}
365
 
366
struct RechargeOrder {
6031 rajveer 367
    1:i64 id,
368
    2:string displayId,
369
    3:i64 totalAmount,
370
    4:i64 walletAmount,
371
    5:i64 transactionId,
6077 anupam.sin 372
    6:i64 invoiceNumber,
6031 rajveer 373
    7:OrderType orderType,
374
    8:i64 operatorId,
375
    9:RechargeType rechargeType,
376
   10:RechargeOrderStatus status,
377
   11:string deviceNumber,
378
   12:i64 userId,
379
   13:string userEmailId,
6048 rajveer 380
   14:i64 creationTimestamp,
381
   15:string spiceTID,
6094 rajveer 382
   16:i64 responseTimestamp,
6159 rajveer 383
   17:string description,
6433 anupam.sin 384
   18:string plan,
385
   19:string couponCode,
6515 anupam.sin 386
   20:i64 couponAmount,
6591 anupam.sin 387
   21:i64 refundTimestamp,
388
   22:string ipAddress
6000 mandeep.dh 389
}
390
 
6188 rajveer 391
struct RechargeStatistics{
6190 rajveer 392
	1:map<i64, i64> statusCounts,
393
	2:map<i64, i64> operatorCounts,
6188 rajveer 394
    3:map<string, list<RechargeOrder>> currentOrders,
395
    4:map<string, i64> amounts
396
}
397
 
6159 rajveer 398
struct RechargePlan {
399
	1:i64 operatorId,
400
    2:string name,
401
    3:string displayName,
402
    4:string description
403
}
404
 
6289 anupam.sin 405
struct RechargeDenomination {
406
	1:i64 operatorId,
407
	2:i64 circleId,
408
	3:DenominationType denominationType,
409
	4:i64 amount,
410
	5:string validity,
411
	6:string description
412
}
413
 
414
struct DeviceNumberInfo {
415
	1:i64 operatorId,
6336 anupam.sin 416
	2:string circleCode
6310 anupam.sin 417
	3:string operatorName
6289 anupam.sin 418
}
419
 
6031 rajveer 420
struct UserWallet {
6000 mandeep.dh 421
    1:i64 id,
422
    2:i64 amount,
6031 rajveer 423
    3:i64 userId   
6000 mandeep.dh 424
}
425
 
6031 rajveer 426
struct UserWalletHistory {
427
	1:i64 id,
428
    2:i64 walletId,
429
    3:i64 orderId,
430
    4:i64 amount,
431
    5:i64 timestamp    
6000 mandeep.dh 432
}
433
 
6389 rajveer 434
enum EmiChargeType {
435
    FIXED = 1,
436
    PERCENTAGE = 2
437
}
438
 
439
struct EmiScheme{
440
    1:i64 id,
441
    2:i64 gatewayId,
442
	3:i64 bankId,
443
    4:i64 tenure,
444
    5:string bankName,
6392 amit.gupta 445
    6:i64 minAmount,
6389 rajveer 446
    7:string tenureDescription,
447
    8:EmiChargeType	chargeType,
6410 rajveer 448
    9:double chargeValue    
6389 rajveer 449
}
450
 
483 rajveer 451
exception TransactionServiceException{
452
	1:i32 errorCode,
453
	2:string message
454
}
455
 
7073 anupam.sin 456
struct Company{
457
    1:i64 id,
458
    2:string name,
459
    3:string Address
460
}
461
 
462
struct WalletForCompany{
463
    1:i64 id,
464
    2:i64 companyId,
465
    3:double amount
466
}
467
 
468
struct WalletHistoryForCompany{
469
    1:i64 id,
470
    2:i64 walletId,
471
    3:double amount,
472
    4:i64 transactionTime,
473
    5:double openingBal,
474
    6:double closingBal,
475
    7:i64 referenceNumber,
476
    8:string description
477
}
478
 
479
enum PayMethod{
480
	CASH = 1,
481
	CARD = 2
482
}
483
 
7080 anupam.sin 484
struct FRC {
485
    1:i64 id,
486
    2:i64 operatorId,
487
    3:i64 circleId,
488
    4:i64 denomination,
489
    5:i64 maxDiscount
490
}
491
 
7096 anupam.sin 492
struct HotspotStore {
493
	1:i64 id,
494
    2:string hotspotId,	
495
    3:i64 companyId,
496
    4:string name,
497
    5:string city,
498
    6:i64 collectedAmount,
499
    7:i64 availableLimit,
500
    8:i64 creditLimit,
501
    9:string salt,
502
    10:string password,
503
    11:bool isActive,
7169 anupam.sin 504
    12:i64 circleId,
505
    13:string email
7096 anupam.sin 506
}
507
 
7073 anupam.sin 508
struct RechargeTransaction{
509
    1:i64 id,
510
    2:i64 storeId,
511
    3:double amount,
512
    4:i64 transactionTime,
513
    5:string deviceNum,
514
    6:RechargeType deviceType,
515
    7:bool isFrc,
516
    8:string email,
517
    9:double discount,
518
    10:double paymentAmount,
519
    11:PayMethod payMethod,
520
    12:RechargeOrderStatus status,
521
    13:string invoiceNumber,
522
    14:i64 circleId,
523
    15:i64 operatorId,
524
    16:string plan,
525
    17:string ipAddress,
526
    18:string name,
527
    19:string cafNum,
7080 anupam.sin 528
    20:string simNum,
7096 anupam.sin 529
    21:string alternateNumber,
7169 anupam.sin 530
    22:string description,
531
    23:i64 responseTime
7073 anupam.sin 532
}
533
 
7096 anupam.sin 534
struct TelecomCircle {
535
	1:i64 id,
536
    2:string name,
537
    3:string code
538
}
539
 
4815 phani.kuma 540
struct OrderStatusGroups{
541
	1:list<OrderStatus> codCancellable = [OrderStatus.COD_VERIFICATION_PENDING,
542
										OrderStatus.SUBMITTED_FOR_PROCESSING,
543
										OrderStatus.ACCEPTED,
544
										OrderStatus.INVENTORY_LOW,
545
										OrderStatus.LOW_INV_PO_RAISED,
546
										OrderStatus.LOW_INV_REVERSAL_IN_PROCESS,
547
										OrderStatus.LOW_INV_NOT_AVAILABLE_AT_HOTSPOT,
548
										OrderStatus.BILLED,
549
										OrderStatus.PAYMENT_FLAGGED],
4837 varun.gupt 550
 
4815 phani.kuma 551
	2:list<OrderStatus> prepaidCancellableBeforeBilled = [OrderStatus.COD_VERIFICATION_PENDING,
552
										OrderStatus.SUBMITTED_FOR_PROCESSING,
553
										OrderStatus.ACCEPTED,
554
										OrderStatus.INVENTORY_LOW,
555
										OrderStatus.LOW_INV_PO_RAISED,
556
										OrderStatus.LOW_INV_REVERSAL_IN_PROCESS,
557
										OrderStatus.LOW_INV_NOT_AVAILABLE_AT_HOTSPOT],
4837 varun.gupt 558
 
559
	3:list<OrderStatus> prepaidCancellableAfterBilled = [OrderStatus.BILLED, OrderStatus.PAYMENT_FLAGGED],
560
 
561
	4:list<OrderStatus> openOrders = [
562
										OrderStatus.PAYMENT_PENDING,			OrderStatus.COD_VERIFICATION_PENDING,
563
										OrderStatus.SUBMITTED_FOR_PROCESSING,	OrderStatus.ACCEPTED,
564
										OrderStatus.INVENTORY_LOW,				OrderStatus.BILLED,
565
										OrderStatus.PAYMENT_FLAGGED,			OrderStatus.SHIPPED_FROM_WH,
566
										OrderStatus.SHIPPED_TO_LOGST,			OrderStatus.PAYMENT_FLAGGED_DENIED,
4910 phani.kuma 567
										OrderStatus.SHIPPED_TO_DESTINATION_CITY,	OrderStatus.REACHED_DESTINATION_CITY,
4837 varun.gupt 568
										OrderStatus.CANCEL_REQUEST_RECEIVED,	OrderStatus.CANCEL_REQUEST_CONFIRMED,
569
										OrderStatus.RTO_IN_TRANSIT,				OrderStatus.RTO_RECEIVED_PRESTINE,
570
										OrderStatus.DOA_PICKUP_REQUEST_RAISED,	OrderStatus.DOA_PICKUP_CONFIRMED,
571
										OrderStatus.DOA_RETURN_IN_TRANSIT,		OrderStatus.DOA_RECEIVED_PRESTINE,
572
										OrderStatus.DOA_CERT_INVALID,			OrderStatus.DOA_CERT_VALID,
573
										OrderStatus.LOW_INV_PO_RAISED,			OrderStatus.LOW_INV_REVERSAL_IN_PROCESS,
574
										OrderStatus.LOW_INV_NOT_AVAILABLE_AT_HOTSPOT,	OrderStatus.LOW_INV_PO_RAISED_TIMEOUT,
4910 phani.kuma 575
										OrderStatus.LOW_INV_REVERSAL_TIMEOUT,	OrderStatus.FIRST_DELIVERY_ATTEMPT_MADE,
4837 varun.gupt 576
										OrderStatus.CAPTURE_IN_PROCESS,			OrderStatus.DOA_REQUEST_RECEIVED,
577
										OrderStatus.DOA_REQUEST_AUTHORIZED,		OrderStatus.DOA_RECEIVED_DAMAGED,
578
										OrderStatus.DOA_LOST_IN_TRANSIT,		OrderStatus.RTO_RECEIVED_DAMAGED,
579
										OrderStatus.RTO_LOST_IN_TRANSIT,		OrderStatus.RTO_INVENTORY_REVERSED,
580
										OrderStatus.RET_REQUEST_RECEIVED,		OrderStatus.RET_REQUEST_AUTHORIZED,
581
										OrderStatus.RET_PICKUP_REQUEST_RAISED,	OrderStatus.RET_PICKUP_DENIED,
582
										OrderStatus.RET_PICKUP_CONFIRMED,		OrderStatus.RET_RETURN_IN_TRANSIT,
583
										OrderStatus.RET_RECEIVED_PRESTINE,		OrderStatus.RET_RECEIVED_DAMAGED,
584
										OrderStatus.RET_LOST_IN_TRANSIT,		OrderStatus.RET_PRODUCT_USABLE,
5867 rajveer 585
										OrderStatus.DELIVERED_AT_STORE,			OrderStatus.RECEIVED_AT_STORE
4983 phani.kuma 586
									],
5031 varun.gupt 587
	5:list<OrderStatus> refundedOrders = [
588
										OrderStatus.CANCELLED_ON_CUSTOMER_REQUEST,	OrderStatus.RTO_REFUNDED,
589
										OrderStatus.DOA_VALID_REFUNDED,				OrderStatus.DOA_INVALID_REFUNDED,
590
										OrderStatus.CANCELLED_DUE_TO_LOW_INVENTORY,	OrderStatus.DOA_REFUNDED_RCVD_DAMAGED,
591
										OrderStatus.DOA_REFUNDED_LOST_IN_TRANSIT,	OrderStatus.RTO_DAMAGED_REFUNDED,
592
										OrderStatus.RTO_LOST_IN_TRANSIT_REFUNDED,	OrderStatus.RET_PRODUCT_USABLE_REFUNDED,
593
										OrderStatus.RET_PRODUCT_UNUSABLE_REFUNDED,	OrderStatus.RET_REFUNDED_LOST_IN_TRANSIT,
594
										OrderStatus.RET_REFUNDED_RCVD_DAMAGED,		OrderStatus.LOST_IN_TRANSIT_REFUNDED
595
									],
596
	6:list<OrderStatus> shippedOrders = [
4983 phani.kuma 597
										OrderStatus.SHIPPED_FROM_WH,			OrderStatus.SHIPPED_TO_LOGST,
598
										OrderStatus.SHIPPED_TO_DESTINATION_CITY,	OrderStatus.REACHED_DESTINATION_CITY,
599
										OrderStatus.RTO_IN_TRANSIT,				OrderStatus.RTO_RECEIVED_PRESTINE,
600
										OrderStatus.DOA_PICKUP_REQUEST_RAISED,	OrderStatus.DOA_PICKUP_CONFIRMED,
601
										OrderStatus.DOA_RETURN_IN_TRANSIT,		OrderStatus.DOA_RECEIVED_PRESTINE,
602
										OrderStatus.DOA_CERT_INVALID,			OrderStatus.DOA_CERT_VALID,
603
										OrderStatus.FIRST_DELIVERY_ATTEMPT_MADE,OrderStatus.DOA_REQUEST_RECEIVED,
604
										OrderStatus.DOA_REQUEST_AUTHORIZED,		OrderStatus.DOA_RECEIVED_DAMAGED,
605
										OrderStatus.DOA_LOST_IN_TRANSIT,		OrderStatus.RTO_RECEIVED_DAMAGED,
606
										OrderStatus.RTO_LOST_IN_TRANSIT,		OrderStatus.RTO_INVENTORY_REVERSED,
607
										OrderStatus.RET_REQUEST_RECEIVED,		OrderStatus.RET_REQUEST_AUTHORIZED,
608
										OrderStatus.RET_PICKUP_REQUEST_RAISED,	OrderStatus.RET_PICKUP_DENIED,
609
										OrderStatus.RET_PICKUP_CONFIRMED,		OrderStatus.RET_RETURN_IN_TRANSIT,
610
										OrderStatus.RET_RECEIVED_PRESTINE,		OrderStatus.RET_RECEIVED_DAMAGED,
611
										OrderStatus.RET_LOST_IN_TRANSIT,		OrderStatus.RET_PRODUCT_USABLE,
5867 rajveer 612
										OrderStatus.RET_PRODUCT_UNUSABLE,		OrderStatus.LOST_IN_TRANSIT,
613
										OrderStatus.DELIVERED_AT_STORE,			OrderStatus.RECEIVED_AT_STORE
4983 phani.kuma 614
									],
5031 varun.gupt 615
	7:list<OrderStatus> failedOrders = [
4983 phani.kuma 616
										OrderStatus.PAYMENT_FAILED,				OrderStatus.CANCELLED_DUE_TO_LOW_INVENTORY,
617
										OrderStatus.REJECTED,					OrderStatus.DOA_INVALID_REFUNDED,
618
										OrderStatus.DOA_INVALID_RESHIPPED,		OrderStatus.DOA_VALID_REFUNDED,
619
										OrderStatus.DOA_VALID_RESHIPPED,		OrderStatus.RTO_REFUNDED,
6566 amit.gupta 620
										OrderStatus.RTO_RESHIPPED, OrderStatus.COD_VERIFICATION_FAILED
4837 varun.gupt 621
									]
4815 phani.kuma 622
}
623
 
3374 rajveer 624
service TransactionService extends GenericService.GenericService{
483 rajveer 625
 
626
	i64 createTransaction(1:Transaction transaction) throws (1:TransactionServiceException ex),
627
 
628
	//	Get transaction methods.
629
	Transaction getTransaction(1:i64 id) throws (1:TransactionServiceException ex),
630
	list<Transaction> getTransactionsForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:TransactionStatus status) throws (1:TransactionServiceException ex),
631
	list<Transaction> getTransactionsForShoppingCartId(1:i64 shoppingCartId) throws (1:TransactionServiceException ex),
632
	TransactionStatus getTransactionStatus(1:i64 transactionId) throws (1:TransactionServiceException ex),
5527 anupam.sin 633
	bool changeTransactionStatus(1:i64 transactionId, 2:TransactionStatus status, 3:string description, 4:i64 pickUp, 5:OrderType orderType) throws (1:TransactionServiceException ex),
1382 varun.gupt 634
 
1398 varun.gupt 635
	bool enqueueTransactionInfoEmail(1:i64 transactionId) throws (1:TransactionServiceException ex),
1382 varun.gupt 636
 
4801 anupam.sin 637
	list<Order> getAllOrders(1:list<OrderStatus> statuses, 2:i64 from_date, 3:i64 to_date, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
1111 varun.gupt 638
 
1115 chandransh 639
	/**
4133 chandransh 640
	Returns at most 'limit' orders with the given statuses for the given warehouse starting from the given offset.
641
	Pass the status as null and the limit as 0 to ignore them.
642
	*/
643
	list<Order> getOrdersInBatch(1:list<OrderStatus> statuses, 2:i64 offset, 3:i64 limit, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),
644
 
645
	/**
646
	Returns the count of orders with the given statuses assigned to the given warehouse.
647
	*/
648
	i32 getOrderCount(1:list<OrderStatus> statuses, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
649
 
650
	/**
1115 chandransh 651
	Returns orders within a range of their billing dates
652
	*/
1000 varun.gupt 653
	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 654
 
1382 varun.gupt 655
	/**
3427 chandransh 656
	Returns orders for a particular provider and warehouse which were shipped between the given dates.
3451 chandransh 657
	Returned orders comprise of COD orders if cod parameter is true. It comprises of prepaid orders otherwise. 
658
	Pass providerId and warehouseId as -1 to ignore both these parameters.
3427 chandransh 659
	*/
3451 chandransh 660
	list<Order> getOrdersByShippingDate(1:i64 fromShippingDate, 2:i64 toShippingDate, 3:i64 providerId, 4:i64 warehouseId, 5:bool cod) throws (1:TransactionServiceException ex),
3427 chandransh 661
 
662
	/**
1382 varun.gupt 663
	Returns order ids for orders which can be returned
664
	*/
665
	list<i64> getReturnableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
666
 
667
	/**
668
	Returns order ids for orders which can be cancelled
669
	*/
670
	list<i64> getCancellableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
671
 
483 rajveer 672
	bool changeOrderStatus(1:i64 orderId, 2:OrderStatus status, 3:string description) throws (1:TransactionServiceException ex),
1147 chandransh 673
 
674
	/**
1529 ankur.sing 675
	Returns list of orders for given transaction Id. Also filters based on customer Id so that
676
	only user who owns the transaction can view its order details.
677
	*/
678
	list<Order> getOrdersForTransaction(1:i64 transactionId 2:i64 customerId)  throws (1:TransactionServiceException ex),
3014 chandransh 679
 
680
	/**
681
	Returns list of orders for the given customer created between the given dates and having the given statuses.
682
	Pass and empty list to ignore filtering on statuses.
683
	*/	
684
	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 685
 
483 rajveer 686
	i64 createOrder(1:Order order) throws (1:TransactionServiceException ex),
687
	Order getOrder(1:i64 id) throws (1:TransactionServiceException ex),
688
	list<LineItem> getLineItemsForOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
689
 
4999 phani.kuma 690
	list<Order> getOrderList(1:list<i64> order_ids),
1529 ankur.sing 691
 
5386 phani.kuma 692
	list<Order> getOrderListForVendor(1:list<i64> order_ids, 2:i64 vendorId),
693
 
757 chandransh 694
	/**
1529 ankur.sing 695
	Returns an order for the order Id. Also checks if the order belongs to the customer whose Id is passed.
696
	Throws exception if either order Id is invalid or order does not below to the customer whose Id is passed.
697
	*/
698
	Order getOrderForCustomer(1:i64 orderId, 2:i64 customerId) throws (1:TransactionServiceException ex),
699
 
3060 chandransh 700
	//Alerts apis 
4444 rajveer 701
	list<Alert> getAlerts(1:i64 type, 2:i64 warehouseId, 3:i64 status, 4:i64 timestamp),
702
	void addAlert(1:i64 type, 2:i64 warehouseId, 3:string description),
703
	void markAlertsAsSeen(1:i64 warehouseId),
3060 chandransh 704
 
1529 ankur.sing 705
	/**
3060 chandransh 706
	Return the number of valid orders. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
707
	*/
708
	i64 getValidOrderCount(),
709
 
710
	/**
711
	Returns the number of distinct customers who have done successful transactions
712
	*/
713
	i64 getNoOfCustomersWithSuccessfulTransaction(),
714
 
715
	/**
716
	Returns the minimum and maximum amounts of a valid order. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
717
	List contains two values, first minimum amount and second maximum amount.	
718
	*/
719
	list<double> getValidOrdersAmountRange(),
720
 
721
	/**
722
	Returns list of Orders in descending order by Order creation date. List is restricted to limit Orders.
723
	If limit is passed as 0, then all valid Orders are returned. 
724
	*/
5874 rajveer 725
	list<Order> getValidOrders(1:i64 limit, 2:bool onlyStore),
3060 chandransh 726
 
727
	/**
728
	Create a batch of all the pending orders for the given warehouse.
729
	The returned list is orderd by created_timestamp.
730
	If there are no pending orders, an empty list is returned.
731
	*/
1223 chandransh 732
	list<Order> batchOrders(1:i64 warehouseId) throws (1:TransactionServiceException ex),
733
 
734
	/**
735
	Mark the given order as out of stock. Throws an exception if the order with the given Id couldn't be found. 
1244 chandransh 736
	*/
1210 chandransh 737
	bool markOrderAsOutOfStock(1:i64 orderId) throws (1:TransactionServiceException ex),
738
 
739
	/**
3060 chandransh 740
	Marks the given order as SUBMITTED_FOR_PROCESSING and updates the verified
741
	timestamp. It is intended to be used for COD orders but can be harmlessly 
742
	used for all other orders as well.
743
	Throws an exception if no such order exists.
757 chandransh 744
	*/
3060 chandransh 745
	bool verifyOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
1115 chandransh 746
 
747
	/**
3060 chandransh 748
	Marks the given order as ACCEPTED and updates the accepted timestamp. If the
749
	given order is not a COD order, it also captures the payment if the same has
750
	not been captured.
751
	Throws an exception if no such order exists.
752
	*/
753
	bool acceptOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
754
 
755
	/**
756
	Add billing details such as the bill number and the biller to the Order.
4658 mandeep.dh 757
	Adds jacket number, item number and Serial no. to the order. Doesn't update
3060 chandransh 758
	the IMEI no. if a -1 is supplied.
759
	Also, it generates an invoice number for the order, marks the order as
760
	BILLED and sets the billing timestamp.
761
	Returns false if it doesn't find the order with the given ID.
762
	*/
5411 rajveer 763
	bool addBillingDetails(1:i64 orderId, 2:string invoice_number, 3:list<string> serialNumber, 4:list<string> itemNumber, 5:string billed_by, 6:i64 jacketNumber, 7:i64 billingType, 8:i64 fulfilmentWarehouseId, 9:bool authorize) throws (1:TransactionServiceException ex),
4579 rajveer 764
 
765
	/**
766
	Add the invoice number to the order.
767
	*/	
6747 amar.kumar 768
	void addInvoiceNumber(1:i64 orderId, 2:string invoiceNumber, 3:string color, 4:string serialNumber, 5:string itemNumber) throws (1:TransactionServiceException ex),
4910 phani.kuma 769
 
3060 chandransh 770
	/**
771
	Depending on the third parameter, marks either all prepaid or all cod orders BILLED by the
4410 rajveer 772
	given warehouse and were picked up by the given provider as SHIPPED_FROM_WH.
773
	*/
4788 rajveer 774
	bool markOrdersAsShippedFromWarehouse(1:i64 warehouseId, 2:i64 providerId, 3:bool cod, 4:list<i64> orderIds) throws (1:TransactionServiceException ex),
5676 rajveer 775
 
5713 rajveer 776
	bool markOrdersAsReturnedFromStore(1:i64 providerId, 2:list<i64> orderIds, 3:list<string> awbs) throws (1:TransactionServiceException ex),
4410 rajveer 777
 
778
	/**
1115 chandransh 779
	Marks all SHIPPED_FROM_WH orders of the previous day for a provider as SHIPPED_TO_LOGISTICS.
4910 phani.kuma 780
	Raises an exception if we encounter report for an AWB number that we did not ship.	
781
	*/
782
	void markOrdersAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails) throws (1:TransactionServiceException ex),
783
 
784
	/**
1115 chandransh 785
	Returns a list of orders that were shipped from warehouse but did not appear in the pick-up report.
786
	*/
4910 phani.kuma 787
	list<Order> getOrdersNotPickedUp(1:i64 providerId),
1134 chandransh 788
 
789
	/**
790
	Marks all orders with AWBs in the given map as delivered. Also sets the delivery timestamp and
791
	the name of the receiver.
792
	Raises an exception if we encounter report for an AWB number that we did not ship.
793
	*/
794
	void markOrdersAsDelivered(1:i64 providerId, 2:map<string, string> deliveredOrders) throws (1:TransactionServiceException ex),
795
 
796
	/**
4910 phani.kuma 797
	Mark all orders with AWBs in the given map as RTO. Also sets the delivery timestamp.
1134 chandransh 798
	Raises an exception if we encounter report for an AWB number that we did not ship.
799
	*/
4910 phani.kuma 800
	void markAsRTOrders(1:i64 providerId, 2:map<string, string> returnedOrders) throws (1:TransactionServiceException ex),
1134 chandransh 801
 
1244 chandransh 802
	/**
4910 phani.kuma 803
	Returns a list of orders that were returned by courier.
804
	*/
805
	list<Order> getRTOrders(1:i64 providerId),
806
 
807
	/**
1244 chandransh 808
	Update the status description of orders whose AWB numbers are keys of the Map.
4910 phani.kuma 809
	*/
810
	void updateNonDeliveryReason(1:i64 providerId, 2:map<string, string> undeliveredOrders) throws (1:TransactionServiceException ex),
811
 
812
	/**
4581 phani.kuma 813
	Returns a list of orders that were picked up or shipped four days ago but did not get delivered.
1244 chandransh 814
	*/
4910 phani.kuma 815
	list<Order> getNonDeliveredOrdersbyCourier(1:i64 providerId),
1244 chandransh 816
 
1407 ankur.sing 817
	/**
4910 phani.kuma 818
	Mark all orders with AWBs in the given map as local connected. Also sets the local connected timestamp.
819
	*/
820
	void markOrdersAsLocalConnected(1:i64 providerId, 2:map<string, string> local_connected_orders) throws (1:TransactionServiceException ex),
821
 
822
	/**
823
	Returns a list of orders that were picked up or shipped but pending local connection.
824
	*/
825
	list<Order> getOrdersNotLocalConnected(1:i64 providerId),
826
 
827
	/**
828
	Mark all orders with AWBs in the given map as reached destination city. Also sets the reached destination timestamp.
829
	*/
830
	void markOrdersAsDestinationCityReached(1:i64 providerId, 2:map<string, string> destination_city_reached_orders) throws (1:TransactionServiceException ex),
831
 
832
	/**
833
	Mark all orders with AWBs in the given map as first delivery attempt made. Also sets the first delivery attempted timestamp.
834
	*/
835
	void markOrdersAsFirstDeliveryAttempted(1:i64 providerId, 2:map<string, string> first_atdl_orders) throws (1:TransactionServiceException ex),
836
 
837
	/**
1407 ankur.sing 838
	Returns the list of orders whose delivery time has passed but have not been
839
	delivered yet for the given provider and warehouse. To get a complete list of
840
	undelivered orders, pass them as -1. 
841
	Returns an empty list if no such orders exist.
842
	*/
843
	list<Order> getUndeliveredOrders(1:i64 providerId, 2:i64 warehouseId),
844
 
1599 ankur.sing 845
	/**
4783 phani.kuma 846
	Returns the list of orders whose expected delivery date has passed but have not been
847
	delivered yet.
848
	Returns an empty list if no such orders exist.
849
	*/
850
	list<Order> getUndeliveredOrdersExpectedDeliveryDateNotMet(),
851
 
852
	/**
2537 chandransh 853
	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.
854
	Returns the final flag status.
855
	Throws an exception if the order with the given id couldn't be found or if the order status is not DELVIERY_SUCCESS. 
856
	*/
857
	bool toggleDOAFlag(1:i64 orderId) throws (1:TransactionServiceException ex),
858
 
4712 rajveer 859
	void markOrderAsDelivered(1:i64 orderId, 2:i64 deliveryTimestamp, string receiver) throws (1:TransactionServiceException ex),
860
 
5553 rajveer 861
	void markOrderAsReceivedAtStore(1:i64 orderId, 2:i64 deliveryTimestamp) throws (1:TransactionServiceException ex),
862
 
2537 chandransh 863
	/**
4454 rajveer 864
	 Once user raise the request for a DOA, order status will be changed from DELVIERY_SUCCESS to DOA_REQUEST_RECEIVED 
865
	*/
866
	bool markOrderDoaRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
867
 
868
	/**
869
	 CRM person can authorize or deny the request reised by customer. If he authorizes order will change from DOA_REQUEST_RECEIVED 
870
	 to DOA_REQUEST_AUTHORIZED. If he denies, status will be changed back to DELVIERY_SUCCESS. 
871
	*/
872
	bool markOrderDoaRequestAuthorized(1:i64 orderId, 2:bool isAuthorized) throws (1:TransactionServiceException ex),
873
 
874
	/**
4488 rajveer 875
	 Once user raise the request for a RET, order status will be changed from DELVIERY_SUCCESS to RET_REQUEST_RECEIVED 
876
	*/
877
	bool markOrderReturnRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
878
 
879
	/**
880
	 CRM person can authorize or deny the request reised by customer. If he authorizes order will change from RET_REQUEST_RECEIVED 
881
	 to RET_REQUEST_AUTHORIZED. If he denies, status will be changed back to DELVIERY_SUCCESS. 
882
	*/
883
	bool markOrderReturnRequestAuthorized(1:i64 orderId, 2:bool isAuthorized) throws (1:TransactionServiceException ex),
884
 
885
	/**
2537 chandransh 886
	Sends out an email to the account manager of the original courier provider used to ship the order.
4452 rajveer 887
	If the order status was DELIVERY_SUCCESS, it is changed to be DOA_PICKUP_REQUEST_RAISED.
888
	If the order status was DOA_PICKUP_REQUEST_RAISED, it is left unchanged.
2537 chandransh 889
	For any other status, it returns false.
890
	Throws an exception if the order with the given id couldn't be found.
891
	*/
4579 rajveer 892
	bool requestPickupNumber(1:i64 orderId, 2:i64 providerId) throws (1:TransactionServiceException ex),
2537 chandransh 893
 
894
	/**
4452 rajveer 895
	If the order status is DOA_PICKUP_REQUEST_RAISED, it does the following
2537 chandransh 896
		1. Sends out an email to the customer with the dispatch advice that he has to print as an attachment.
897
		2. Changes order status to be DOA_PICKUP_AUTHORIZED.
898
		3. Returns true
2589 chandransh 899
	If the order is in any other status, it returns false.
2537 chandransh 900
	Throws an exception if the order with the given id couldn't be found.
901
	*/
4602 rajveer 902
	bool authorizePickup(1:i64 orderId, 2:string pickupNumber, 3:i64 providerId) throws (1:TransactionServiceException ex),
2589 chandransh 903
 
904
	/**
2765 chandransh 905
	Marks all DOA_PICKUP_AUTHORIZED orders of the previous day for a provider as DOA_RETURN_IN_TRANSIT.
4910 phani.kuma 906
	*/
907
	void markDoasAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails),
908
 
909
	/**
2765 chandransh 910
	Returns a list of orders that were authorized for pickup but did not appear in the pick-up report.
911
	*/
4910 phani.kuma 912
	list<Order> getDoasNotPickedUp(1:i64 providerId),
2765 chandransh 913
 
914
	/**
4741 phani.kuma 915
	Marks all RET_PICKUP_CONFIRMED orders of the previous day for a provider as RET_RETURN_IN_TRANSIT.
4910 phani.kuma 916
	*/
917
	void markReturnOrdersAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails),
918
 
919
	/**
4741 phani.kuma 920
	Returns a list of orders that were authorized for pickup but did not appear in the pick-up report.
921
	*/
4910 phani.kuma 922
	list<Order> getReturnOrdersNotPickedUp(1:i64 providerId),
4741 phani.kuma 923
 
924
	/**
4452 rajveer 925
	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 926
	If the order status is RTO_IN_TRANSIT, marks the order status as RTO_RECEIVED_PRESTINE and returns true.
2589 chandransh 927
	If the order is in any other state, it returns false.
928
	Throws an exception if the order with the given id couldn't be found.
929
	*/
4478 rajveer 930
	bool receiveReturn(1:i64 orderId, 2:i64 receiveCondition) throws (1:TransactionServiceException ex),
2589 chandransh 931
 
932
	/**
4452 rajveer 933
	Used to validate the DOA certificate for an order in the DOA_RECEIVED_PRESTINE state. If the certificate is valid,
2614 chandransh 934
	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 935
	If the order is in any other state, it returns false.
936
	Throws an exception if the order with the given id couldn't be found.
937
	*/
938
	bool validateDoa(1:i64 orderId, 2:bool isValid) throws (1:TransactionServiceException ex),
2614 chandransh 939
 
4495 rajveer 940
	bool validateReturnProduct(1:i64 orderId, 2:bool isUsable) throws (1:TransactionServiceException ex),
941
 
2614 chandransh 942
	/**
4484 rajveer 943
	If the order is in RTO_RECEIVED_PRESTINE or DOA_CERT_INVALID state, it does the following:
2614 chandransh 944
		1. Creates a new order for processing in the BILLED state. All billing information is saved.
4484 rajveer 945
		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 946
 
947
	If the order is in DOA_CERT_VALID state, it does the following:
948
		1. Creates a new order for processing in the SUBMITTED_FOR_PROCESSING state.
949
		2. Creates a return order for the warehouse executive to return the DOA material.
4452 rajveer 950
		3. Marks the current order as the final DOA_VALID_RESHIPPED state.
2614 chandransh 951
 
952
	Returns the id of the newly created order.
953
 
954
	Throws an exception if the order with the given id couldn't be found.
955
	*/
956
	i64 reshipOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
957
 
958
	/**
4484 rajveer 959
	If the order is in RTO_RECEIVED_PRESTINE, DOA_CERT_VALID or DOA_CERT_INVALID state, it does the following:
2614 chandransh 960
		1. Creates a refund request for batch processing.
961
		2. Creates a return order for the warehouse executive to return the shipped material.
4484 rajveer 962
		3. Marks the current order as RTO_REFUNDED, DOA_VALID_REFUNDED or DOA_INVALID_REFUNDED final states.
2614 chandransh 963
 
964
	If the order is in SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
965
		1. Creates a refund request for batch processing.
3226 chandransh 966
		2. Cancels the reservation of the item in the warehouse.
967
		3. Marks the current order as the REFUNDED final state.
2614 chandransh 968
 
3226 chandransh 969
	For all COD orders, if the order is in INIT, SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:
970
		1. Cancels the reservation of the item in the warehouse.
971
		2. Marks the current order as CANCELED.	
972
 
973
	In all cases, it updates the reason for cancellation or refund and the person who performed the action.
974
 
2614 chandransh 975
	Returns True if it is successful, False otherwise.
976
 
977
	Throws an exception if the order with the given id couldn't be found.
978
	*/
3226 chandransh 979
	bool refundOrder(1:i64 orderId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
2688 chandransh 980
 
981
	/**
982
	Get all return orders created between the from and to dates for the given warehouse.
983
	Ignores the warehouse if it is passed as -1.
984
	*/
985
	list<ReturnOrder> getReturnOrders(1:i64 warehouseId, 2:i64 fromDate, 3:i64 toDate),
986
 
987
	/**
5481 phani.kuma 988
	Get all return orders created between the from and to dates.
989
	*/
990
	list<ReturnOrder> getAllReturnOrders(1:bool onlyNotProcessed, 2:i64 fromDate, 3:i64 toDate),
991
 
992
	/**
2700 chandransh 993
	Returns the ReturnOrder corresponding to the given id.
994
	Throws an exception if the return order with the given id couldn't be found.
995
	*/
996
	ReturnOrder getReturnOrder(1:i64 id) throws (1:TransactionServiceException ex),
997
 
998
	/**
2688 chandransh 999
	Marks the return order with the given id as processed. Raises an exception if no such return order exists. 
1000
	*/
2819 chandransh 1001
	void processReturn(1:i64 returnOrderId) throws (1:TransactionServiceException ex),
1002
 
1003
	/**
3451 chandransh 1004
	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.
1005
	*/
3469 chandransh 1006
	Order updateWeight(1:i64 orderId, 2:double weight) throws (1:TransactionServiceException ex),
1007
 
1008
	/**
1009
	Change the item to be shipped for this order. Also adjusts the reservation in the inventory accordingly.
1010
	Currently, it also ensures that only a different color of the given item is shipped.
1011
	*/
1012
	Order changeItem(1:i64 orderId, 2:i64 itemId) throws (1:TransactionServiceException ex),
1013
 
1014
	/**
1015
	Moves the given order to the given warehouse. Also adjusts the inventory reservations accordingly.
1016
	*/
3553 chandransh 1017
	Order shiftToWarehouse(1:i64 orderId, 2:i64 warehouseId) throws (1:TransactionServiceException ex),
1018
 
1019
	/**
1020
	Adds the given delay reason to the given order.
3986 chandransh 1021
	Increases the expected delivery time of the given order by the given no. of days.
3553 chandransh 1022
	Raises an exception if no order with the given id can be found.
1023
	*/
4647 rajveer 1024
	bool addDelayReason(1:i64 orderId, 2:DelayReason delayReason, 3:i64 furtherDelay, 4:string delayReasonText) throws (1:TransactionServiceException ex),
3956 chandransh 1025
 
1026
	/**
1027
	Marks the COD orders with given AWB nos. as having been processed.
1028
	Updates the captured amount for the corresponding payment.
1029
 
1030
	Returns a map of AWBs which were not processed and the associated reason. An AWB is not processed if:
1031
	1. There is no order corresponding to an AWB number.
1032
	2. The captured amount for a payment exceeds the total payment.
1033
	3. The order corresponding to an AWB no. is in a state prior to DELIVERY_SUCCESS.
1034
	*/
4008 mandeep.dh 1035
	map<string, string> reconcileCodCollection(1:map<string, double> collectedAmountMap, 2:string xferBy, 3:string xferTxnId, 4:i64 xferDate) throws (1:TransactionServiceException ex),
1036
 
1037
    /**
4065 mandeep.dh 1038
     * Returns the list of transaction ids that require some extra processing and
4008 mandeep.dh 1039
     * which belong to a particular category. This is currently used by CRM
4065 mandeep.dh 1040
     * application. If no such transaction ids are present, it returns an empty list.
4008 mandeep.dh 1041
     */
1042
    list<i64> getTransactionsRequiringExtraProcessing(1:ExtraTransactionProcessingType category),
1043
 
1044
	/**
1045
	 * Marks a particular transaction as processed for a particular cateogory.
4065 mandeep.dh 1046
	 * It essentially deletes the transaction id record for a particular
1047
	 * processing type category (if present) from DB.
1048
	 * This is currently used by CRM application.
4008 mandeep.dh 1049
	 */
4018 chandransh 1050
	void markTransactionAsProcessed(1:i64 transactionId, 2:ExtraTransactionProcessingType category),
1051
 
1052
	/**
1053
	Returns a map containing the number of risky orders keyed by item id. A risky order
1054
	is defined as one whose shipping date is about to expire.
1055
	*/
4245 rajveer 1056
	map<i64, i64> getItemWiseRiskyOrdersCount(),
1057
 
1058
	/**
4295 varun.gupt 1059
	Returns a list of all orders which have items with given id
1060
	*/
1061
	list<Order> getOrdersForItemIds(1:list<i64> itemIds),
1062
 
1063
	/**
4245 rajveer 1064
	 * Mark order as cancellation request received. If customer sends request of cancellation of 
1065
	 * a particular order, this method will be called. It will just change status of the order 
1066
	 * depending on its current status. It also records the previous status, so that we can move 
1067
	 * back to that status if cancellation request is denied.
1068
	 */
1069
	void markOrderCancellationRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),
1070
 
1071
	/**
1072
	 * If we decide to to cancel order, CRM will call this method to move the status of order to 
1073
	 * cancellation request confirmed. After this OM will be able to cancel the order. 	
1074
	 */
1075
	void markOrderCancellationRequestConfirmed(1:i64 orderId) throws (1:TransactionServiceException ex),
1076
 
1077
	/**
1078
	 * If we decide to not to cancel order, we will move the order ro previous status.	
1079
	 */
1080
	void markOrderCancellationRequestDenied(1:i64 orderId) throws (1:TransactionServiceException ex),
1081
 
1082
	/**
4258 rajveer 1083
	 * If we and/or payment gateway has decided to accept the payment, this method needs to be called.
1084
	 * Changed transaction and all orders status to payment accepted.  
4245 rajveer 1085
	 */
4285 rajveer 1086
	void markTransactionAsPaymentFlagRemoved(1:i64 transactionId) throws (1:TransactionServiceException ex),
4245 rajveer 1087
 
4259 anupam.sin 1088
	/**
1089
	* This method is called when a flagged payment is deemed unserviceable and the corresponding orders
1090
	* need to be cancelled
1091
	*/
4285 rajveer 1092
	void refundTransaction(1:i64 transactionId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),
4324 mandeep.dh 1093
 
1094
	/**
1095
	 * Updates shipment address of an order. Delivery and shipping date estimates
1096
	 * etc. are also updated here.
1097
	 *
1098
	 * Throws TransactionServiceException in case address change is not
1099
	 * possible due to certain reasons such as new pincode in address is
1100
	 * not serviceable etc.
1101
	 */
1102
	void updateShipmentAddress(1:i64 orderId, 2:i64 addressId) throws (1:TransactionServiceException ex)
4285 rajveer 1103
 
1104
	/**
1105
	Marks the orders as ACCEPTED for the given itemId and inventory. It also updates the accepted timestamp. If the
1106
	given order is not a COD order, it also captures the payment if the same has not been captured.
1107
	*/
4303 rajveer 1108
	bool acceptOrdersForItemId(1:i64 itemId, 2:i64 inventory) throws (1:TransactionServiceException ex),
4285 rajveer 1109
 
4369 rajveer 1110
	void markOrdersAsPORaised(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
1111
	void markOrdersAsReversalInitiated(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
1112
	void markOrdersAsNotAvailabke(1:i64 vendorId, 2:i64 itemId, 3:i64 quantity, 4:i64 estimate, 5:bool isReminder) throws (1:TransactionServiceException ex),
1113
 
4386 anupam.sin 1114
	map<i32, TimeoutSummary> markOrdersAsTimeout(1:i64 vendorId) throws (1:TransactionServiceException ex),
4661 rajveer 1115
 
4386 anupam.sin 1116
	/**
4661 rajveer 1117
	Mark order as LOST_IN_TRANSIT
1118
	*/
1119
	bool markOrderAsLostInTransit(1:i64 orderId) throws (1:TransactionServiceException ex),
1120
 
1121
	/**
4386 anupam.sin 1122
	Returns the order corresponding to an AWB number
1123
	*/
4586 mandeep.dh 1124
	Order getOrderForAwb(1:string awb) throws (1:TransactionServiceException ex),
4506 phani.kuma 1125
 
1126
	/**
4910 phani.kuma 1127
	Returns the order corresponding to a logistics provider id for a given list of order status
4506 phani.kuma 1128
	*/
4910 phani.kuma 1129
	list<Order> getOrdersForProviderForStatus(1:i64 logistics_provider_id, 2:list<OrderStatus> order_status_list) throws (1:TransactionServiceException ex)
4600 varun.gupt 1130
 
1131
	/**
1132
	Returns list of orders fullfiled from a certain vendor and billed in a given date range
1133
	*/
1134
	list<Order> getBilledOrdersForVendor(1:i64 vendorId, 2:i64 billingDateFrom, 3:i64 billingDateTo) throws (1:TransactionServiceException ex),
1135
 
4607 rajveer 1136
	list<Order> getSlippedSippingDateOrders() throws (1:TransactionServiceException ex),
1137
 
4709 rajveer 1138
	list<Order> getCancelledOrders(1:i64 cancelDateFrom, 2:i64 cancelDateTo) throws (1:TransactionServiceException ex),
1139
 
4600 varun.gupt 1140
	void saveBluedartSettlements(1:map<i64, double> mapAWBAndAmount) throws (1:TransactionServiceException ex),
1141
 
4905 varun.gupt 1142
	void savePaymentSettlements(1:i64 settlementDate, 2:i64 paymentGatewayId, 3:i64 referenceId, 4:double serviceTax, 5:double otherCharges, 6:double netCollection) throws (1:TransactionServiceException ex),
4600 varun.gupt 1143
 
1144
	void saveEBSSettlementSummary(1:i64 settlementId, 2:i64 settlementDate, 3:i64 transactionDateFrom, 4:i64 transactionDateTo, 5:double amount) throws (1:TransactionServiceException ex),
1145
 
5386 phani.kuma 1146
	PaymentSettlement getSettlementForPrepaid(1:i64 referenceId, 2:bool isRefund) throws (1:TransactionServiceException ex),
4600 varun.gupt 1147
 
5386 phani.kuma 1148
	PaymentSettlement getSettlementForCod(1:i64 orderId, 2:bool isRefund) throws (1:TransactionServiceException ex),
1149
 
4600 varun.gupt 1150
	map<i64, string> getEBSSettlementSummaries() throws (1:TransactionServiceException ex),
1151
 
1152
	void markEBSSettlementUploaded(1:i64 settlementId) throws (1:TransactionServiceException ex),
1153
 
4715 varun.gupt 1154
	i64 getEBSSettlementDate(1:i64 settlementId) throws (1:TransactionServiceException ex),
1155
 
1156
	list<PaymentSettlement> getSettlementsByDate(1:i64 settlementDateFrom, 2:i64 settlementDateTo, 3:bool isRefund) throws (1:TransactionServiceException ex),
1157
 
1158
	/**
1159
	Returns list of Order Ids, which belong to reshiped orders, shortlisted from a given list of Order Ids 
1160
	*/
4875 varun.gupt 1161
	list<i64> getReshippedOrderIds(1:list<i64> orderIds) throws (1:TransactionServiceException ex),
1162
 
5481 phani.kuma 1163
	list<Order> getBilledOrders(1:i64 vendorId, 2:bool onlyVendorNotPaid, 3:i64 billingDateFrom, 4:i64 billingDateTo) throws (1:TransactionServiceException ex),
5031 varun.gupt 1164
 
5067 varun.gupt 1165
	map<i64, i64> getStatusDistributionOfOrders(1:i64 startDate, 2:i64 endDate) throws (1:TransactionServiceException ex),
1166
 
5099 varun.gupt 1167
	list<i64> getOrderIdsForStatus(1:i64 status, 2:i64 startDatetime, 3:i64 endDatetime) throws (1:TransactionServiceException ex),
1168
 
5348 anupam.sin 1169
	/**
1170
	 * Updates the agent who handled the COD verification call
1171
	 */
1172
	void updateCODAgent(1:string agent, 2:i64 orderId) throws (1:TransactionServiceException ex),
1173
 
5208 varun.gupt 1174
	void updateOrderAsPaidToVendor(1:i64 orderId) throws (1:TransactionServiceException ex),
1175
 
5386 phani.kuma 1176
	void updateOrderOnlyAsPaidToVendor(1:i64 orderId) throws (1:TransactionServiceException ex),
1177
 
5447 anupam.sin 1178
	list<Order> getRefundedOrdersMarkedPaid() throws (1:TransactionServiceException ex),
1179
 
1180
	/**
1181
	* gets all COD Verification Agents for all orderIds from a minId to maxId
1182
	*
1183
	*/
5527 anupam.sin 1184
	list<CODVerificationAgent> getAllVerificationAgents(1:i64 minOrderId, 2:i64 maxOrderId),
1185
 
1186
	/**
1187
	* gets all attributes for a given orderId
1188
	*/
1189
	list<Attribute> getAllAttributesForOrderId(1:i64 orderId),
1190
 
1191
	/**
5676 rajveer 1192
	* sets attributes for an order
1193
	*/
1194
	void setOrderAttributes(1:i64 orderId, list<Attribute> attributes),
1195
 
1196
	/**
5527 anupam.sin 1197
	* sets attributes for all orders in a transaction
1198
	*/
5553 rajveer 1199
	void setOrderAttributeForTransaction(1:i64 transactionId, Attribute attribute),
1200
 
1201
	list<Order> getReceivePendingOrders(1:i64 storeId),
1202
 
5593 mandeep.dh 1203
	list<Order> getReceivedAtStoreOrders(1:i64 storeId),
5713 rajveer 1204
 
1205
	list<Order> getOrdersCollectionAtStore(1:i64 storeId, 2:i64 fromDate, 3:i64 toDate, 4:bool onlyCod),
5593 mandeep.dh 1206
 
5833 rajveer 1207
	string getOrderAttributeValue(1:i64 orderId, string attributeName),
6019 rajveer 1208
 
1209
	bool changeJacketNumber(1:i64 orderId, 2:i64 jacketNumber),
1210
 
1211
	bool markOrderAsRtoInTransit(1:i64 orderId),
1212
 
5593 mandeep.dh 1213
	/**
1214
	 * Accepts appropriate order for an item in a given billingWarehouse. Usually
1215
	 * invoked while scanning IN of items.
1216
	 */
6000 mandeep.dh 1217
	 void acceptOrderForItem(1:i64 itemId, 2:i64 quantity, 3:i64 fulfilmentWarehouseId, 4:i64 billingWarehouseId);
1218
 
1219
	 RechargeOrder createRechargeOrder(1:RechargeOrder rechargeOrder) throws  (1:TransactionServiceException ex);
6031 rajveer 1220
	 RechargeOrder getRechargeOrder(1:i64 rechargeRrderId) throws  (1:TransactionServiceException ex);
1221
	 list<RechargeOrder> getRechargeOrders(1:i64 userId);
1222
 
1223
	 bool updateRechargeOrderStatus(1:i64 rechargeOrderId, 2:RechargeOrderStatus rechargeOrderStatus) throws  (1:TransactionServiceException ex);
1224
	 bool activateRechargeTxn(1:i64 rechargeOrderId) throws  (1:TransactionServiceException ex);
1225
	 UserWallet getUserWallet(1:i64 userId);
1226
	 list<UserWalletHistory> getUserWalletHistory(1:i64 userId);
6050 anupam.sin 1227
	 /**
1228
	 Returns a recharge order for a given transactionId
1229
	 */
1230
	 RechargeOrder getRechargeOrdersForTransaction(1:i64 txnId) throws (1:TransactionServiceException ex);
6206 rajveer 1231
	 map<i64, string> getServiceProviders(1:RechargeType rechargeType, 2:bool onlyActive);
6289 anupam.sin 1232
	 DeviceNumberInfo getServiceProviderForDevice(1:RechargeType rechargeType, 2:string deviceNumber);
6591 anupam.sin 1233
	 string validateRecharge(1:RechargeType rechargeType, 2:string deviceNumber, 3:i64 userSelectedProviderId, 4:string clientAddress);
6094 rajveer 1234
	 list<RechargeOrder> getRechargeOrdersForDevice(1:string deviceNumber);
1235
	 void addAmountToWallet(1:i64 userId, 2:i64 orderId, 3:i64 amount);
6188 rajveer 1236
 
1237
	 RechargeStatistics getRechargeStatistics();
1238
 
6154 rajveer 1239
	 list<RechargeOrder> getRechargeOrdersForStatus(1:i64 status);
6159 rajveer 1240
	 list<RechargePlan> getPlansForOperator(1:i64 operatorId);
6289 anupam.sin 1241
 
1242
	 /**
1243
	 Returns denominations for a given operator and circle
1244
	 */
6307 anupam.sin 1245
	 list<RechargeDenomination> getRechargeDenominations(1:i64 operatorId, 2:string circleCode, 3:DenominationType denominationType) throws (1:TransactionServiceException ex);
6371 rajveer 1246
 
1247
	 void updateAvailabilityStatus(1:i64 operatorId, 2:i64 circleId, 3:bool isAvailable);
6389 rajveer 1248
 
1249
	 list<EmiScheme> getAvailableEmiSchemes();
1250
 
6412 rajveer 1251
	 map<i64, double> getMiscCharges(1:i64 transactionId);
6507 anupam.sin 1252
 
1253
	 bool refundRechargeOrder(1:i64 rechargeOrderId) throws (1:TransactionServiceException ex);
6821 amar.kumar 1254
 
6906 rajveer 1255
	 list<Order> getPhysicalOrders(1:i64 fromDate, 2:i64 toDate);
1256
 
1257
	 binary getDocument(1:i64 docType, 2:i64  docSource);
6985 anupam.sin 1258
 
1259
	 bool changeShippingAddress(1:i64 orderId, 2:string line1, 3:string line2, 4:string city, 5:string state, 6:string pin);
6988 rajveer 1260
 
7075 rajveer 1261
	 binary retrieveInvoice(1:i64 orderId, 2:i64 userId);
6988 rajveer 1262
 
7026 rajveer 1263
	 list<string> receiveUpdatesForRedExpress(1:string awbNumber);
7073 anupam.sin 1264
 
1265
	 RechargeTransaction createRechargeTransaction(1:RechargeTransaction thriftRechargeTransaction);
7080 anupam.sin 1266
 
7084 rajveer 1267
	 list<RechargeTransaction> getRechargeTransactions(1:i64 storeId);
7151 amit.gupta 1268
 
1269
	 list<RechargeTransaction> getRechargeTrans(1:i64 storeId, 2:i64 startDate, 3:i64 endDate, 4:RechargeOrderStatus status);
7084 rajveer 1270
 
7080 anupam.sin 1271
	 RechargeTransaction getRechargeTransaction(1:i64 rechargeId);
1272
 
1273
	 list<FRC> getFRCs(1:i64 circleId, 2:i64 operatorId);
7096 anupam.sin 1274
 
1275
	 HotspotStore getHotspotStore(1:i64 id, 2:string hotspotid);
1276
 
1277
	 TelecomCircle getTelecomCircle(1:i64 id, 2:string code);
7109 anupam.sin 1278
 
1279
	 binary retrieveHotspotRechargeInvoice(1:i64 rechargeId);
7169 anupam.sin 1280
 
1281
	 list<RechargeTransaction> getRechargeTransactionsByNumber(1:string number);
1282
 
1283
	 bool updateHotspotStorePassword(1:i64 storeId, 2:string password);
6000 mandeep.dh 1284
}