Subversion Repositories SmartDukaan

Rev

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