Subversion Repositories SmartDukaan

Rev

Rev 4452 | Rev 4459 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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