Subversion Repositories SmartDukaan

Rev

Rev 5739 | Rev 5813 | 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 
 
5553 rajveer 59 
struct PickupStore {
5719 rajveer 60 
	1:i64 id,
61 
	2:string hotspotId,
62 
	3:string name,
63 
    4:string line1,
64 
    5:string line2,
65 
    6:string city,
66 
    7:string state,
67 
    8:string pin,
5739 rajveer 68 
    9:string phone,
69 
    10:string zone
5553 rajveer 70 
}
71 
 
472 rajveer 72 
exception LogisticsServiceException{
73 
	1:i64 id,
74 
	2:string message
75 
}
76 
 
3374 rajveer 77 
service LogisticsService extends GenericService.GenericService{
646 chandransh 78 
	/**
667 chandransh 79 
	 Returns a provider for a given provider ID. Throws an exception if none found.
80 
	*/
81 
	Provider getProvider(1:i64 providerId) throws (1:LogisticsServiceException lse),
82 
 
83 
	/**
673 chandransh 84 
	 Returns a list containing all the providers.
85 
	*/
86 
	list<Provider> getAllProviders() throws (1:LogisticsServiceException lse),
87 
 
88 
	/**
646 chandransh 89 
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
90 
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
4630 mandeep.dh 91 
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
646 chandransh 92 
	 */
4630 mandeep.dh 93 
	LogisticsInfo getLogisticsEstimation(1:i64 itemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se),
483 rajveer 94 
 
646 chandransh 95 
	/**
96 
	 Same as above excpet that an airway bill number is also allocated and returned.
97 
	*/
5766 rajveer 98 
	LogisticsInfo getLogisticsInfo(1:string destination_pincode, 2:i64 item_id, 3:DeliveryType type, 4:PickUpType pickUp) throws (1:LogisticsServiceException se),
477 rajveer 99 
 
646 chandransh 100 
	/**
101 
	 Returns an unused AWB number for the given provider.
102 
	*/
5247 rajveer 103 
	string getEmptyAWB(1:i64 providerId, DeliveryType type) throws (1:LogisticsServiceException se),
472 rajveer 104 
 
646 chandransh 105 
	/**
106 
	 Returns the list of updates for the given AWB number and provider id. The list is empty if there are no updates yet.
107 
	*/
729 chandransh 108 
	list<AwbUpdate> getShipmentInfo(1:string awb, 2:i64 providerId) throws (1:LogisticsServiceException se),
109 
 
110 
	/**
111 
	 Returns the short three letter code of a pincode for the given provider.
112 
     Raises an exception if the pin code is not serviced by the given provider.
113 
	*/
1138 chandransh 114 
	string getDestinationCode(1:i64 providerId, 2:string pinCode) throws (1:LogisticsServiceException se),
115 
 
116 
	/**
3103 chandransh 117 
	Returns the number of unused AWB numbers for the given provider of the given type
1138 chandransh 118 
	*/
3103 chandransh 119 
	i64 getFreeAwbCount(1:i64 providerId, 2:string type),
1730 ankur.sing 120 
 
121 
	/**
122 
	Returns list of Holiday dates between fromDate and toDate (both inclusive)
123 
	fromDate should be passed as milliseconds corresponding to the start of the day.
124 
	If fromDate is passed as -1, fromDate is not considered for filtering
125 
	If toDate is passed as -1, toDate is not considered for filtering
126 
	*/
4934 amit.gupta 127 
	list<i64> getHolidays(1:i64 fromDate, 2:i64 toDate),
128 
 
129 
	/**
130 
	 Returns a LogisticsInfo structure w/o an airway bill number. Use this method during the estimation phase.
131 
	 Raises an exception if this pincode is not allocated to any warehouse zone or provider. Also, if the pincode
132 
	 is allocated to a warehouse zone but there are no actual warehouses in that zone, an exception is raised.
133 
	 */
134 
	list<i64> getEntityLogisticsEstimation(1:i64 catalogItemId, 2:string destination_pin, 3:DeliveryType type) throws (1:LogisticsServiceException se)
5527 anupam.sin 135 
 
136 
	/**
137 
	* Returns the id for a given pickUpType
138 
	*/
5553 rajveer 139 
	i64 getProviderForPickupType(1:i64 pickUp),
140 
 
141 
 
142 
	list<PickupStore> getAllPickupStores(),
143 
 
5719 rajveer 144 
	PickupStore getPickupStore(1:i64 storeId),
145 
 
146 
	PickupStore getPickupStoreByHotspotId(1:string hotspotId)
412 ashish 147 
}