Subversion Repositories SmartDukaan

Rev

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