Subversion Repositories SmartDukaan

Rev

Rev 6524 | Rev 6725 | 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,
6643 rajveer 43
    2:i64 providerId,
44
    3:i64 date,
45
    4:string status,
46
    5:string description,
47
    6:string location
412 ashish 48
}
49
 
5110 mandeep.dh 50
struct LogisticsInfo {
646 chandransh 51
	1:i64 warehouseId,
52
	2:i64 providerId,
53
	3:i64 deliveryTime,
4009 chandransh 54
	4:string airway_billno,
4865 rajveer 55
	5:i64 shippingTime,
5110 mandeep.dh 56
	6:bool codAllowed,
6524 rajveer 57
	7:i64 fulfilmentWarehouseId,
58
	8:bool otgAvailable
483 rajveer 59
}
60
 
5553 rajveer 61
struct PickupStore {
5719 rajveer 62
	1:i64 id,
63
	2:string hotspotId,	
64
	3:string name,
65
    4:string line1,
66
    5:string line2,
67
    6:string city,
68
    7:string state,
69
    8:string pin,
5739 rajveer 70
    9:string phone,
5863 rajveer 71
    10:string email,
72
    11:string zone,
73
    12:string bdm,
74
    13:string bdmEmail
5553 rajveer 75
}
76
 
472 rajveer 77
exception LogisticsServiceException{
78
	1:i64 id,
79
	2:string message
80
}
81
 
3374 rajveer 82
service LogisticsService extends GenericService.GenericService{
646 chandransh 83
	/**
667 chandransh 84
	 Returns a provider for a given provider ID. Throws an exception if none found.
85
	*/
86
	Provider getProvider(1:i64 providerId) throws (1:LogisticsServiceException lse),
87
 
88
	/**
673 chandransh 89
	 Returns a list containing all the providers.
90
	*/
91
	list<Provider> getAllProviders() throws (1:LogisticsServiceException lse),
92
 
93
	/**
646 chandransh 94
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
95
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
4630 mandeep.dh 96
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
646 chandransh 97
	 */
4630 mandeep.dh 98
	LogisticsInfo getLogisticsEstimation(1:i64 itemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se),
483 rajveer 99
 
646 chandransh 100
	/**
101
	 Same as above excpet that an airway bill number is also allocated and returned.
102
	*/
5766 rajveer 103
	LogisticsInfo getLogisticsInfo(1:string destination_pincode, 2:i64 item_id, 3:DeliveryType type, 4:PickUpType pickUp) throws (1:LogisticsServiceException se),
477 rajveer 104
 
646 chandransh 105
	/**
106
	 Returns an unused AWB number for the given provider.
107
	*/
5247 rajveer 108
	string getEmptyAWB(1:i64 providerId, DeliveryType type) throws (1:LogisticsServiceException se),
472 rajveer 109
 
646 chandransh 110
	/**
111
	 Returns the list of updates for the given AWB number and provider id. The list is empty if there are no updates yet.
112
	*/
6643 rajveer 113
	list<AwbUpdate> getShipmentInfo(1:string awbNumber, 2:i64 providerId) throws (1:LogisticsServiceException se),
729 chandransh 114
 
115
	/**
6643 rajveer 116
	 Store the update for the given AWB number and provider id.
117
	*/
118
	void storeShipmentInfo(1:AwbUpdate update) throws (1:LogisticsServiceException se),
119
 
120
 
121
	/**
729 chandransh 122
	 Returns the short three letter code of a pincode for the given provider.
123
     Raises an exception if the pin code is not serviced by the given provider.
124
	*/
1138 chandransh 125
	string getDestinationCode(1:i64 providerId, 2:string pinCode) throws (1:LogisticsServiceException se),
126
 
127
	/**
3103 chandransh 128
	Returns the number of unused AWB numbers for the given provider of the given type  
1138 chandransh 129
	*/
3103 chandransh 130
	i64 getFreeAwbCount(1:i64 providerId, 2:string type),
1730 ankur.sing 131
 
132
	/**
133
	Returns list of Holiday dates between fromDate and toDate (both inclusive)
134
	fromDate should be passed as milliseconds corresponding to the start of the day.
135
	If fromDate is passed as -1, fromDate is not considered for filtering
136
	If toDate is passed as -1, toDate is not considered for filtering
137
	*/
4934 amit.gupta 138
	list<i64> getHolidays(1:i64 fromDate, 2:i64 toDate),
139
 
140
	/**
141
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
142
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
143
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
144
	 */
145
	list<i64> getEntityLogisticsEstimation(1:i64 catalogItemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se)
5527 anupam.sin 146
 
147
	/**
148
	* Returns the id for a given pickUpType
149
	*/
5553 rajveer 150
	i64 getProviderForPickupType(1:i64 pickUp),
151
 
152
 
153
	list<PickupStore> getAllPickupStores(),
154
 
5719 rajveer 155
	PickupStore getPickupStore(1:i64 storeId),
156
 
6322 amar.kumar 157
	PickupStore getPickupStoreByHotspotId(1:string hotspotId),
158
 
6524 rajveer 159
	void addPincode(1:i64 providerId, 2:string pincode, 3:string destCode, 4:bool exp, 5:bool cod, 6:i32 stationType, 7:bool otgAvailable)
6322 amar.kumar 160
 
6524 rajveer 161
	void updatePincode(1:i64 providerId, 2:string pincode, 3:bool exp, 4:bool cod, 5:bool otgAvailable)
412 ashish 162
}