Subversion Repositories SmartDukaan

Rev

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

Rev Author Line No. Line
412 ashish 1
namespace java in.shop2020.logistics
2
namespace py shop2020.thriftpy.logistics
3
 
3374 rajveer 4
include "GenericService.thrift"
5
 
646 chandransh 6
enum StationType{
7
	OWN_STATION = 0,		//The service provider's own station.
8
	ASSOCIATE_STATION = 1	//An associate's station
472 rajveer 9
}
442 rajveer 10
 
646 chandransh 11
enum WarehouseLocation{
12
	Delhi = 0,
13
	Mumbai = 1,
14
	Bangalore = 2,
15
	Kolkata = 3
412 ashish 16
}
17
 
3044 chandransh 18
enum DeliveryType {
19
	PREPAID = 0,
20
	COD = 1
21
}
22
 
5527 anupam.sin 23
enum PickUpType {
24
	COURIER = 0,
25
	RUNNER = 1,
26
	SELF = 2
27
}
28
 
3044 chandransh 29
struct ProviderDetails{
30
	1:string accountNo,
31
	2:string email
32
}
33
 
412 ashish 34
struct Provider{
35
	1:i64 id,
667 chandransh 36
	2:string name,
5527 anupam.sin 37
	3:map<DeliveryType, ProviderDetails> details,
38
	4:PickUpType pickup
412 ashish 39
}
40
 
646 chandransh 41
struct AwbUpdate{
42
    1:string awbNumber,
43
    2:string providerName,
44
    3:string location,
45
    4:i64 entryDate,
46
    5:string description
412 ashish 47
}
48
 
5110 mandeep.dh 49
struct LogisticsInfo {
646 chandransh 50
	1:i64 warehouseId,
51
	2:i64 providerId,
52
	3:i64 deliveryTime,
4009 chandransh 53
	4:string airway_billno,
4865 rajveer 54
	5:i64 shippingTime,
5110 mandeep.dh 55
	6:bool codAllowed,
56
	7:i64 fulfilmentWarehouseId
483 rajveer 57
}
58
 
472 rajveer 59
exception LogisticsServiceException{
60
	1:i64 id,
61
	2:string message
62
}
63
 
3374 rajveer 64
service LogisticsService extends GenericService.GenericService{
646 chandransh 65
	/**
667 chandransh 66
	 Returns a provider for a given provider ID. Throws an exception if none found.
67
	*/
68
	Provider getProvider(1:i64 providerId) throws (1:LogisticsServiceException lse),
69
 
70
	/**
673 chandransh 71
	 Returns a list containing all the providers.
72
	*/
73
	list<Provider> getAllProviders() throws (1:LogisticsServiceException lse),
74
 
75
	/**
646 chandransh 76
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
77
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
4630 mandeep.dh 78
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
646 chandransh 79
	 */
4630 mandeep.dh 80
	LogisticsInfo getLogisticsEstimation(1:i64 itemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se),
483 rajveer 81
 
646 chandransh 82
	/**
83
	 Same as above excpet that an airway bill number is also allocated and returned.
84
	*/
3044 chandransh 85
	LogisticsInfo getLogisticsInfo(1:string destination_pincode, 2:i64 item_id, 3:DeliveryType type) throws (1:LogisticsServiceException se),
477 rajveer 86
 
646 chandransh 87
	/**
88
	 Returns an unused AWB number for the given provider.
89
	*/
5247 rajveer 90
	string getEmptyAWB(1:i64 providerId, DeliveryType type) throws (1:LogisticsServiceException se),
472 rajveer 91
 
646 chandransh 92
	/**
93
	 Returns the list of updates for the given AWB number and provider id. The list is empty if there are no updates yet.
94
	*/
729 chandransh 95
	list<AwbUpdate> getShipmentInfo(1:string awb, 2:i64 providerId) throws (1:LogisticsServiceException se),
96
 
97
	/**
98
	 Returns the short three letter code of a pincode for the given provider.
99
     Raises an exception if the pin code is not serviced by the given provider.
100
	*/
1138 chandransh 101
	string getDestinationCode(1:i64 providerId, 2:string pinCode) throws (1:LogisticsServiceException se),
102
 
103
	/**
3103 chandransh 104
	Returns the number of unused AWB numbers for the given provider of the given type  
1138 chandransh 105
	*/
3103 chandransh 106
	i64 getFreeAwbCount(1:i64 providerId, 2:string type),
1730 ankur.sing 107
 
108
	/**
109
	Returns list of Holiday dates between fromDate and toDate (both inclusive)
110
	fromDate should be passed as milliseconds corresponding to the start of the day.
111
	If fromDate is passed as -1, fromDate is not considered for filtering
112
	If toDate is passed as -1, toDate is not considered for filtering
113
	*/
4934 amit.gupta 114
	list<i64> getHolidays(1:i64 fromDate, 2:i64 toDate),
115
 
116
	/**
117
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
118
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
119
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
120
	 */
121
	list<i64> getEntityLogisticsEstimation(1:i64 catalogItemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se)
5527 anupam.sin 122
 
123
	/**
124
	* Returns the id for a given pickUpType
125
	*/
126
	i64 getProviderForPickupType(1:i64 pickUp)
412 ashish 127
}