WebSVN – SmartDukaan – Diff – /trunk/ThriftGen/thriftsrc/OrderService/OrderService.thrift

 enum TransactionStatus{
 	INIT,
 	IN_PROCESS,
 	COMPLETED,
 	FAILED,
-	AUTHORIZED
+	AUTHORIZED,
+	COD_IN_PROCESS
+}
 struct LineItem{
 :i64 id,
 :i64 item_id,
 :i64 batchNo,
 :i64 serialNo,
 :bool doaFlag,
 :string pickupRequestNo,
 :i64 transactionId,
-:string purchaseOrderNo
+:string purchaseOrderNo,
+:bool cod
+}
 struct Transaction{
 :i64 id,
 :list<Order> orders,
 	list<i64> getCancellableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),
 	bool changeOrderStatus(1:i64 orderId, 2:OrderStatus status, 3:string description) throws (1:TransactionServiceException ex),
 	/**
-	Add billing details such as the bill number and the biller to the Order.
-	*/
-	bool addBillingDetails(1:i64 orderId, 2:string invoice_number, 3:string billed_by) throws (1:TransactionServiceException ex),
-	/**
-	Adds jacket number and IMEI no. to the order. Doesn't update the IMEI no. if a -1 is supplied.
-	Also marks the order as billed and sets the billing timestamp.
-	Return false if it doesn't find the order with the given ID.
-	*/
-	bool addJacketNumber(1:i64 orderId, 2:i64 jacketNumber, 3:i64 imeiNumber, 4:string itemNumber, 5:string billedBy, 6:i64 billingType) throws (1:TransactionServiceException ex),
-	bool acceptOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
-	bool billOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
-	/**
 	Returns list of orders for given transaction Id. Also filters based on customer Id so that
 	only user who owns the transaction can view its order details.
 	*/
 	list<Order> getOrdersForTransaction(1:i64 transactionId 2:i64 customerId)  throws (1:TransactionServiceException ex),
 	Returns an order for the order Id. Also checks if the order belongs to the customer whose Id is passed.
 	Throws exception if either order Id is invalid or order does not below to the customer whose Id is passed.
 	*/
 	Order getOrderForCustomer(1:i64 orderId, 2:i64 customerId) throws (1:TransactionServiceException ex),
+	//Alerts apis
+	list<Alert> getAlerts(1:i64 orderId, 2:bool valid),
+	void setAlert(1:i64 orderId, 2:bool unset, 3:i64 type, 4: string comment),
+	/**
+	Return the number of valid orders. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
+	*/
+	i64 getValidOrderCount(),
+	/**
+	Returns the number of distinct customers who have done successful transactions
+	*/
+	i64 getNoOfCustomersWithSuccessfulTransaction(),
+	/**
+	Returns the minimum and maximum amounts of a valid order. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
+	List contains two values, first minimum amount and second maximum amount.
+	*/
+	list<double> getValidOrdersAmountRange(),
 	/**
+	Returns list of Orders in descending order by Order creation date. List is restricted to limit Orders.
+	If limit is passed as 0, then all valid Orders are returned.
+	*/
+	list<Order> getValidOrders(1:i64 limit),
+	/**
-	 Create a batch of all the pending orders for the given warehouse.
+	Create a batch of all the pending orders for the given warehouse.
-	 The returned list is orderd by created_timestamp.
+	The returned list is orderd by created_timestamp.
-	 If there are no pending orders, an empty list is returned.
+	If there are no pending orders, an empty list is returned.
-	 */
+	*/
 	list<Order> batchOrders(1:i64 warehouseId) throws (1:TransactionServiceException ex),
 	/**
 	Mark the given order as out of stock. Throws an exception if the order with the given Id couldn't be found.
 	*/
 	bool markOrderAsOutOfStock(1:i64 orderId) throws (1:TransactionServiceException ex),
 	/**
+	Marks the given order as SUBMITTED_FOR_PROCESSING and updates the verified
+	timestamp. It is intended to be used for COD orders but can be harmlessly
+	used for all other orders as well.
+	Throws an exception if no such order exists.
+	*/
+	bool verifyOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
+	/**
-	Marks all BILLED orders for a warehouse and a provider as SHIPPED_FROM_WH
+	Marks the given order as ACCEPTED and updates the accepted timestamp. If the
+	given order is not a COD order, it also captures the payment if the same has
+	not been captured.
+	Throws an exception if no such order exists.
 	*/
+	bool acceptOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
+	bool billOrder(1:i64 orderId) throws (1:TransactionServiceException ex),
+	/**
+	Add billing details such as the bill number and the biller to the Order.
+	Should be used when the bill is issued by a 3rd party and we've to feed
+	the information into our system.
+	*/
+	bool addBillingDetails(1:i64 orderId, 2:string invoice_number, 3:string billed_by) throws (1:TransactionServiceException ex),
+	/**
+	Adds jacket number, item number and IMEI no. to the order. Doesn't update
+	the IMEI no. if a -1 is supplied.
+	Also, it generates an invoice number for the order, marks the order as
+	BILLED and sets the billing timestamp.
+	It should be used when we are billing the orders ourselves.
+	Returns false if it doesn't find the order with the given ID.
+	*/
+	bool addJacketNumber(1:i64 orderId, 2:i64 jacketNumber, 3:i64 imeiNumber, 4:string itemNumber, 5:string billedBy, 6:i64 billingType) throws (1:TransactionServiceException ex),
+	/**
+	Depending on the third parameter, marks either all prepaid or all cod orders BILLED by the
+	given warehouse and were picked up by the given provider as SHIPPED_FROM_WH.
+	*/
-	bool markOrdersAsManifested(1:i64 warehouseId, 2:i64 providerId) throws (1:TransactionServiceException ex),
+	bool markOrdersAsManifested(1:i64 warehouseId, 2:i64 providerId, 3:bool cod) throws (1:TransactionServiceException ex),
 	/**
 	Marks all SHIPPED_FROM_WH orders of the previous day for a provider as SHIPPED_TO_LOGISTICS.
 	Returns a list of orders that were shipped from warehouse but did not appear in the pick-up report.
 	Raises an exception if we encounter report for an AWB number that we did not ship.
 	undelivered orders, pass them as -1.
 	Returns an empty list if no such orders exist.
 	*/
 	list<Order> getUndeliveredOrders(1:i64 providerId, 2:i64 warehouseId),
-	//Alerts apis
-	list<Alert> getAlerts(1:i64 orderId, 2:bool valid),
-	void setAlert(1:i64 orderId, 2:bool unset, 3:i64 type, 4: string comment),
-	/**
-	Return the number of valid orders. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
-	*/
-	i64 getValidOrderCount(),
-	/**
-	Returns the number of distinct customers who have done successful transactions
-	*/
-	i64 getNoOfCustomersWithSuccessfulTransaction(),
-	/**
-	Returns the minimum and maximum amounts of a valid order. (OrderStatus >= OrderStatus.SUBMITTED_FOR_PROCESSING)
-	List contains two values, first minimum amount and second maximum amount.
-	*/
-	list<double> getValidOrdersAmountRange(),
-	/**
-	Returns list of Orders in descending order by Order creation date. List is restricted to limit Orders.
-	If limit is passed as 0, then all valid Orders are returned.
-	*/
-	list<Order> getValidOrders(1:i64 limit),
 	/**
 	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.
 	Returns the final flag status.
 	Throws an exception if the order with the given id couldn't be found or if the order status is not DELVIERY_SUCCESS.
 	*/

Subversion Repositories SmartDukaan

(root)/trunk/ThriftGen/thriftsrc/OrderService/OrderService.thrift – Rev 3014 → 3060