Subversion Repositories SmartDukaan

Rev

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