Subversion Repositories SmartDukaan

Rev

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