Subversion Repositories SmartDukaan

Rev

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