Subversion Repositories SmartDukaan

namespace java in.shop2020.model.v1.order

namespace py shop2020.thriftpy.model.v1.order

include "GenericService.thrift"

/***

	Order objects.

*/

enum OrderStatus{

	PAYMENT_PENDING,

	PAYMENT_FAILED,

	INIT,

	SUBMITTED_FOR_PROCESSING,

	ACCEPTED,

	INVENTORY_LOW,

	REJECTED,

	BILLED,

	PAYMENT_FLAGGED, 

	SHIPPED_FROM_WH,

	SHIPPED_TO_LOGST,

	PAYMENT_FLAGGED_DENIED,      

	DELIVERY_SUCCESS,

	CANCEL_REQUEST_RECEIVED,

	CANCEL_REQUEST_CONFIRMED,

	CANCELLED_ON_CUSTOMER_REQUEST,

	CANCELLED_DUE_TO_LOW_INVENTORY,

	COMPLETED,                  //Not Used

	CANCELED,

	FAILED,

	SALES_RETURN_IN_TRANSIT,

	SALES_RET_RECEIVED,

	DOA_PICKUP_REQUESTED,

	DOA_RETURN_AUTHORIZED,

	DOA_RETURN_IN_TRANSIT,

	DOA_RECEIVED,

	DOA_CERT_INVALID,

	DOA_CERT_VALID,

	SALES_RET_RESHIPPED,

	DOA_INVALID_RESHIPPED,

	DOA_RESHIPPED,

	SALES_RET_REFUNDED,

	DOA_VALID_REFUNDED,

	DOA_INVALID_REFUNDED,

	REFUNDED

}

enum TransactionStatus{

	INIT,

	IN_PROCESS,

	COMPLETED,

	FAILED,

	AUTHORIZED,

	COD_IN_PROCESS,

	FLAGGED

}

enum ExtraTransactionProcessingType {

    COD_VERIFICATION,

    DELAYED_DELIVERY,

    PAYMENT_FLAGGED

}

struct LineItem{

	1:i64 id,

	2:i64 item_id,

	3:string productGroup,

	4:string brand,

	5:string model_number,

	6:string color

	7:string model_name,

	8:string extra_info,

	9:double quantity,

	10:double unit_price,

	11:double unit_weight,

	12:double total_price,

	13:double transfer_price,

	14:double total_weight,

	15:optional i64 imei_number,

	16:optional string item_number,

	17:optional string dealText

}

enum DelayReason {

	INVENTORY_LOW_PHASED_OUT,

	INVENTORY_LOW_COLOR_NOT_AVAILABLE,

	INVENTORY_LOW_REVERSAL_NOT_ON_TIME,

	INVENTORY_LOW_PRODUCT_NOT_SEALED,

	COURIER_DELAY_NOT_DELIVERED_TO_COURIER_ON_TIME,

	COURIER_DELAY_DID_NOT_CONNECT,

	COURIER_DELAY_CUSTOMER_NOT_AVAILABLE,

	COURIER_DELAY_INCORRECT_ADDRESS

	COURIER_DELAY_OCTROI_DELAY,

	COURIER_DELAY_FORCES_OF_NATURE,

	COD_VERIFICATION_DELAY,

	PAYMENT_FLAGGED,

	OTHERS

}

struct Order{

	1:i64 id,

	2:i64 warehouse_id,

	/**

		item info

	**/

	3:list<LineItem> lineitems,

	/**

	  logistics info

	**/

	4:i64 logistics_provider_id,

	5:string airwaybill_no,

	6:string tracking_id,

	7:i64 expected_delivery_time,

	/**

	  customer info

	**/

	8:i64 customer_id,

	9:string customer_name,

	10:string customer_mobilenumber,

	11:string customer_pincode,

	12:string customer_address1,

	13:string customer_address2,

	14:string customer_email,

	15:string customer_city,

	16:string customer_state,

	/**

		status and misc info

	**/

	17:OrderStatus status,

	18:string statusDescription,

	19:double total_amount,

	20:double total_weight,

	/**

		billing info

	**/

	21:string invoice_number,

	22:string billed_by,

	/**

		timestamps

	**/

	23:i64 created_timestamp,

	24:i64 accepted_timestamp,

	25:i64 billing_timestamp,

	26:i64 shipping_timestamp,

	27:i64 pickup_timestamp,

	28:i64 delivery_timestamp,

	29:i64 outofstock_timestamp,

	30:i64 jacket_number,

	31:string receiver,

	32:i64 batchNo,

	33:i64 serialNo,

	34:bool doaFlag,

	35:string pickupRequestNo,

	36:i64 transactionId,

	37:string purchaseOrderNo,

	38:bool cod,

	39:DelayReason delayReason,

	40:i64 promised_delivery_time,

	41:i64 expected_shipping_time,

	42:i64 verification_timestamp,

	43:i64 promised_shipping_time,

	44:optional i64 reship_timestamp,

	45:optional i64 refund_timestamp,

	46:optional i64 new_order_id,

	47:OrderStatus previousStatus

}

struct OrderStatusAuditTrail{

	1:i64 id,

	2:i64 orderId,

	3:i64 status,

	4:i64 timestamp,

	5:i64 description

}

struct Transaction{

	1:i64 id,

	2:list<Order> orders,

	3:i64 createdOn,

	4:TransactionStatus transactionStatus,

	5:string statusDescription,

	6:i64 shoppingCartid,

	7:i64 customer_id,

	8:string coupon_code,

	9:string sessionSource,

	10:i64 sessionStartTime,

	11:string firstSource,

    12:i64 firstSourceTime

}

struct Alert{

	1:i64 id,

	2:i64 order_id,

	3:i64 type,

	4:i64 time_set,

	5:string comment,

	6:i64 time_unset

}

struct ReturnOrder{

	1:i64 orderId,

	2:i64 warehouseId,

    3:i64 jacketNumber,

    4:string invoiceNumber,

    5:i64 itemId,

    6:string productGroup,

    7:string brand,

    8:string modelNumber,

    9:string modelName,

    10:string color,

    11:double totalPrice,

    12:double transferPrice,

    13:bool processedStatus,

    14:i64 createdAt,

    15:i64 processedAt

}

exception TransactionServiceException{

	1:i32 errorCode,

	2:string message

}

service TransactionService extends GenericService.GenericService{

	i64 createTransaction(1:Transaction transaction) throws (1:TransactionServiceException ex),

	//	Get transaction methods.

	Transaction getTransaction(1:i64 id) throws (1:TransactionServiceException ex),

	list<Transaction> getTransactionsForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:TransactionStatus status) throws (1:TransactionServiceException ex),

	list<Transaction> getTransactionsForShoppingCartId(1:i64 shoppingCartId) throws (1:TransactionServiceException ex),

	TransactionStatus getTransactionStatus(1:i64 transactionId) throws (1:TransactionServiceException ex),

	bool changeTransactionStatus(1:i64 transactionId, 2:TransactionStatus status, 3:string description) throws (1:TransactionServiceException ex),

	bool enqueueTransactionInfoEmail(1:i64 transactionId) throws (1:TransactionServiceException ex),

	list<Order> getAllOrders(1:OrderStatus status, 2:i64 from_date, 3:i64 to_date, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),

	/**

	Returns at most 'limit' orders with the given statuses for the given warehouse starting from the given offset.

	Pass the status as null and the limit as 0 to ignore them.

	*/

	list<Order> getOrdersInBatch(1:list<OrderStatus> statuses, 2:i64 offset, 3:i64 limit, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),

	/**

	Returns the count of orders with the given statuses assigned to the given warehouse.

	*/

	i32 getOrderCount(1:list<OrderStatus> statuses, 2:i64 warehouseId) throws (1:TransactionServiceException ex),

	/**

	Returns orders within a range of their billing dates

	*/

	list<Order> getOrdersByBillingDate(1:OrderStatus status, 2:i64 start_billing_date, 3:i64 end_billing_date, 4:i64 warehouse_id) throws (1:TransactionServiceException ex),

	/**

	Returns orders for a particular provider and warehouse which were shipped between the given dates.

	Returned orders comprise of COD orders if cod parameter is true. It comprises of prepaid orders otherwise. 

	Pass providerId and warehouseId as -1 to ignore both these parameters.

	*/

	list<Order> getOrdersByShippingDate(1:i64 fromShippingDate, 2:i64 toShippingDate, 3:i64 providerId, 4:i64 warehouseId, 5:bool cod) throws (1:TransactionServiceException ex),

	/**

	Returns order ids for orders which can be returned

	*/

	list<i64> getReturnableOrdersForCustomer(1:i64 customer_id, 2:i64 limit) throws (1:TransactionServiceException ex),

	/**

	Returns order ids for orders which can be cancelled

	*/

	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),

	/**

	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 list of orders for the given customer created between the given dates and having the given statuses.

	Pass and empty list to ignore filtering on statuses.

	*/	

	list<Order> getOrdersForCustomer(1:i64 customerId, 2:i64 from_date, 3:i64 to_date, 4:list<OrderStatus> statuses) throws (1:TransactionServiceException ex),

	i64 createOrder(1:Order order) throws (1:TransactionServiceException ex),

	Order getOrder(1:i64 id) throws (1:TransactionServiceException ex),

	list<LineItem> getLineItemsForOrder(1:i64 orderId) 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.

	The returned list is orderd by created_timestamp.

	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 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, 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.

	*/

	list<Order> markOrdersAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails) throws (1:TransactionServiceException ex),

	/**

	Marks all orders with AWBs in the given map as delivered. Also sets the delivery timestamp and

	the name of the receiver.

	Raises an exception if we encounter report for an AWB number that we did not ship.

	*/

	void markOrdersAsDelivered(1:i64 providerId, 2:map<string, string> deliveredOrders) throws (1:TransactionServiceException ex),

	/**

	Mark all orders with AWBs in the given map as failed. Also sets the delivery timestamp.

	Raises an exception if we encounter report for an AWB number that we did not ship.

	*/

	void markOrdersAsFailed(1:i64 providerId, 2:map<string, string> returnedOrders) throws (1:TransactionServiceException ex),

	/**

	Update the status description of orders whose AWB numbers are keys of the Map.

	*/

	void updateNonDeliveryReason(1:i64 providerId, 2:map<string, string> undeliveredOrders) throws (1:TransactionServiceException ex),

	/**

	Returns the list of orders whose delivery time has passed but have not been

	delivered yet for the given provider and warehouse. To get a complete list of

	undelivered orders, pass them as -1. 

	Returns an empty list if no such orders exist.

	*/

	list<Order> getUndeliveredOrders(1:i64 providerId, 2:i64 warehouseId),

	/**

	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. 

	*/

	bool toggleDOAFlag(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	Sends out an email to the account manager of the original courier provider used to ship the order.

	If the order status was DELIVERY_SUCCESS, it is changed to be DOA_PICKUP_REQUESTED.

	If the order status was DOA_PICKUP_REQUESTED, it is left unchanged.

	For any other status, it returns false.

	Throws an exception if the order with the given id couldn't be found.

	*/

	bool requestPickupNumber(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	If the order status is DOA_PICKUP_REQUESTED, it does the following

		1. Sends out an email to the customer with the dispatch advice that he has to print as an attachment.

		2. Changes order status to be DOA_PICKUP_AUTHORIZED.

		3. Returns true

	If the order is in any other status, it returns false.

	Throws an exception if the order with the given id couldn't be found.

	*/

	bool authorizePickup(1:i64 orderId, 2:string pickupNumber) throws (1:TransactionServiceException ex),

	/**

	Marks all DOA_PICKUP_AUTHORIZED orders of the previous day for a provider as DOA_RETURN_IN_TRANSIT.

	Returns a list of orders that were authorized for pickup but did not appear in the pick-up report.

	*/

	list<Order> markDoasAsPickedUp(1:i64 providerId, 2:map<string, string> pickupDetails),

	/**

	If the order status is DOA_RETURN_AUTHORIZED or DOA_RETURN_IN_TRANSIT, marks the order status as DOA_RECEIVED and returns true.

	If the order status is SALES_RETURN_IN_TRANSIT, marks the order status as SALES_RET_RECEIVED and returns true.

	If the order is in any other state, it returns false.

	Throws an exception if the order with the given id couldn't be found.

	*/

	bool receiveReturn(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	Used to validate the DOA certificate for an order in the DOA_RECEIVED state. If the certificate is valid,

	the order state is changed to DOA_CERT_VALID. If the certificate is invalid, the order state is changed to DOA_CERT_INVALID.

	If the order is in any other state, it returns false.

	Throws an exception if the order with the given id couldn't be found.

	*/

	bool validateDoa(1:i64 orderId, 2:bool isValid) throws (1:TransactionServiceException ex),

	/**

	If the order is in SALES_RET_RECEIVED or DOA_CERT_INVALID state, it does the following:

		1. Creates a new order for processing in the BILLED state. All billing information is saved.

		2. Marks the current order as one of the final states SALES_RET_RESHIPPED and DOA_INVALID_RESHIPPED depending on what state the order started in.

	If the order is in DOA_CERT_VALID state, it does the following:

		1. Creates a new order for processing in the SUBMITTED_FOR_PROCESSING state.

		2. Creates a return order for the warehouse executive to return the DOA material.

		3. Marks the current order as the final DOA_RESHIPPED state.

	Returns the id of the newly created order.

	Throws an exception if the order with the given id couldn't be found.

	*/

	i64 reshipOrder(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	If the order is in SALES_RET_RECEIVED, DOA_CERT_VALID or DOA_CERT_INVALID state, it does the following:

		1. Creates a refund request for batch processing.

		2. Creates a return order for the warehouse executive to return the shipped material.

		3. Marks the current order as SALES_RET_REFUNDED, DOA_VALID_REFUNDED or DOA_INVALID_REFUNDED final states.

	If the order is in SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:

		1. Creates a refund request for batch processing.

		2. Cancels the reservation of the item in the warehouse.

		3. Marks the current order as the REFUNDED final state.

	For all COD orders, if the order is in INIT, SUBMITTED_FOR_PROCESSING or INVENTORY_LOW state, it does the following:

		1. Cancels the reservation of the item in the warehouse.

		2. Marks the current order as CANCELED.	

	In all cases, it updates the reason for cancellation or refund and the person who performed the action.

	Returns True if it is successful, False otherwise.

	Throws an exception if the order with the given id couldn't be found.

	*/

	bool refundOrder(1:i64 orderId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex),

	/**

	Get all return orders created between the from and to dates for the given warehouse.

	Ignores the warehouse if it is passed as -1.

	*/

	list<ReturnOrder> getReturnOrders(1:i64 warehouseId, 2:i64 fromDate, 3:i64 toDate),

	/**

	Returns the ReturnOrder corresponding to the given id.

	Throws an exception if the return order with the given id couldn't be found.

	*/

	ReturnOrder getReturnOrder(1:i64 id) throws (1:TransactionServiceException ex),

	/**

	Marks the return order with the given id as processed. Raises an exception if no such return order exists. 

	*/

	void processReturn(1:i64 returnOrderId) throws (1:TransactionServiceException ex),

	/**

	Creates a purchase order corresponding to all the pending orders of the given warehouse.

	Returns the PO no. of the newly created purchase order. Returns -1 no new purchase order had to be created.

	*/

	i64 createPurchaseOrder(1:i64 warehouseId) throws (1:TransactionServiceException ex),

	/**

	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.

	*/

	Order updateWeight(1:i64 orderId, 2:double weight) throws (1:TransactionServiceException ex),

	/**

	Change the item to be shipped for this order. Also adjusts the reservation in the inventory accordingly.

	Currently, it also ensures that only a different color of the given item is shipped.

	*/

	Order changeItem(1:i64 orderId, 2:i64 itemId) throws (1:TransactionServiceException ex),

	/**

	Moves the given order to the given warehouse. Also adjusts the inventory reservations accordingly.

	*/

	Order shiftToWarehouse(1:i64 orderId, 2:i64 warehouseId) throws (1:TransactionServiceException ex),

	/**

	Adds the given delay reason to the given order.

	Increases the expected delivery time of the given order by the given no. of days.

	Raises an exception if no order with the given id can be found.

	*/

	bool addDelayReason(1:i64 orderId, 2:DelayReason delayReason, 3:i64 furtherDelay) throws (1:TransactionServiceException ex),

	/**

	Marks the COD orders with given AWB nos. as having been processed.

	Updates the captured amount for the corresponding payment.

	Returns a map of AWBs which were not processed and the associated reason. An AWB is not processed if:

	1. There is no order corresponding to an AWB number.

	2. The captured amount for a payment exceeds the total payment.

	3. The order corresponding to an AWB no. is in a state prior to DELIVERY_SUCCESS.

	*/

	map<string, string> reconcileCodCollection(1:map<string, double> collectedAmountMap, 2:string xferBy, 3:string xferTxnId, 4:i64 xferDate) throws (1:TransactionServiceException ex),

    /**

     * Returns the list of transaction ids that require some extra processing and

     * which belong to a particular category. This is currently used by CRM

     * application. If no such transaction ids are present, it returns an empty list.

     */

    list<i64> getTransactionsRequiringExtraProcessing(1:ExtraTransactionProcessingType category),

	/**

	 * Marks a particular transaction as processed for a particular cateogory.

	 * It essentially deletes the transaction id record for a particular

	 * processing type category (if present) from DB.

	 * This is currently used by CRM application.

	 */

	void markTransactionAsProcessed(1:i64 transactionId, 2:ExtraTransactionProcessingType category),

	/**

	Returns a map containing the number of risky orders keyed by item id. A risky order

	is defined as one whose shipping date is about to expire.

	*/

	map<i64, i64> getItemWiseRiskyOrdersCount(),

	/**

	 * Mark order as cancellation request received. If customer sends request of cancellation of 

	 * a particular order, this method will be called. It will just change status of the order 

	 * depending on its current status. It also records the previous status, so that we can move 

	 * back to that status if cancellation request is denied.

	 */

	void markOrderCancellationRequestReceived(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	 * If we decide to to cancel order, CRM will call this method to move the status of order to 

	 * cancellation request confirmed. After this OM will be able to cancel the order. 	

	 */

	void markOrderCancellationRequestConfirmed(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	 * If we decide to not to cancel order, we will move the order ro previous status.	

	 */

	void markOrderCancellationRequestDenied(1:i64 orderId) throws (1:TransactionServiceException ex),

	/**

	 * If we and/or payment gateway has decided to accept the payment, this method needs to be called.

	 * Changed transaction and all orders status to payment accepted.  

	 */

	void markTransactionAsPaymentFlagRemoved(1:i64 transactionId) throws (1:TransactionServiceException ex)

	/**

	* This method is called when a flagged payment is deemed unserviceable and the corresponding orders

	* need to be cancelled

	*/

	void refundTransaction(1:i64 transactionId, 2:string refundedBy, 3:string reason) throws (1:TransactionServiceException ex)

}