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

 namespace java in.shop2020.warehouse
 namespace py shop2020.thriftpy.warehouse
 include "GenericService.thrift"
-struct Supplier{
-:i64 id,
-:string name,
-:string phone,
-:string fax,
-:string tin,
-:string pan,
-:string headName,
-:string headDesignation,
-:string headEmail,
-:string contactName,
-:string contactPhone,
-:string contactFax,
-:string contactEmail,
-:string registeredAddress,
-:string communicationAddress
-}
-//struct WarehouseDashboardUser{
-//	1:i64 id,
-//	2:string name,
-//	3:string password,
-//	4:Role role
-//}
-struct LineItem{
-:i64 orderId,
-:i64 itemId,
-:string productGroup,
-:string brand,
-:string modelNumber,
-:string modelName,
-:string color,
-:string itemNumber,
-:double quantity,
-:double unfulfilledQuantity,
-:i64 createdAt,
-:double unitPrice,
-:bool fulfilled
-}
-enum POStatus{
-	INIT = 0,					//Just created.
-	READY = 1,					//Posted for fulfillment.
-	PARTIALLY_FULFILLED = 2, 	//Partially fulfullied. Possible to accept purchases against it.
-	PRECLOSED = 3,				//PO was partially fulfilled and the supplier has clarified that he can't supply the remaining items.
-	CLOSED = 4					//PO was completely fulfilled.
-}
-struct PurchaseOrder{
-:i64 id,
-:string poNumber,
-:list<LineItem> lineitems,
-:i64 supplierId,
-:i64 warehouseId,
-:POStatus status,
-:i64 createdAt,
-:i64 updatedAt,
-:double totalCost,
-:double freightCharges,
-:double realizedCost,
-:double realizedFreightCharges
-}
-struct Purchase{
-:i64 id,
-:i64 poId,
-:string invoiceNumber,
-:i64 receivedOn,
-:double freightCharges
-}
-struct Warehouse{
-:i64 id,
-:string displayName,
-:string location
-}
-enum ScanType{
-	PURCHASE = 0,	//Scan-in at the time of purchase
-	SALE = 1,		//Scan-out for sale
-	SALE_RET = 2,	//Scan-in when an item is returned undelivered
-	DOA_IN = 3,		//Scan-in when an item is returned by the customer with the DOA certificate
-	DOA_OUT = 4		//Scan-out to return an item to the supplier
-}
-struct Scan{
-:i64 id,
-:i64 itemId,
-:i64 warehouseId,
-:i64 purchaseId,
-:string itemNumber,
-:string imeiNumber,
-:ScanType type,
-:i64 scannedAt
-}
-exception WarehouseServiceException{
-:i64 id,
-:string message
-}
-service WarehouseService extends GenericService.GenericService{
-	/**
-	Creates a purchase order based on the data in the given purchase order object.
-	This method populates a nummber of missing fields
-	*/
-	i64 createPurchaseOrder(1:PurchaseOrder purchaseOrder) throws (1:WarehouseServiceException wex),
-	/**
-	Returns the purchase order with the given id. Throws an exception if there is no such purchase order.
-	*/
-	PurchaseOrder getPurchaseOrder(1:i64 id) throws (1:WarehouseServiceException wex),
-	/**
-	Returns a list of all the purchase orders in the given state
-	*/
-	list<PurchaseOrder> getAllPurchaseOrders(1:POStatus status) throws(1:WarehouseServiceException wex),
-	/**
-	Returns the supplier with the given order id. Throws an exception if there is no such supplier.
-	*/
-	Supplier getSupplier(1:i64 id) throws (1:WarehouseServiceException wex),
-	/**
-	Creates a purchase for the given purchase order.
-	Throws an exception if no more purchases are allowed against the given purchase order.
-	*/
-	i64 startPurchase(1:i64 purchaseOrderId, 2:string invoiceNumber, 3:double freightCharges) throws (1:WarehouseServiceException wex),
-	/**
-	Marks a purchase as complete and updates the receivedOn time.
-	Throws an exception if no such purchase exists.
-	*/
-	i64 closePurchase(1:i64 purchaseId) throws (1:WarehouseServiceException wex),
-	/**
-	Returns all open or closed purchases for the given purchase order. Throws an exception if no such purchase order exists
-	*/
-	list<Purchase> getAllPurchases(1:i64 purchaseOrderId, 2:bool open) throws(1:WarehouseServiceException wex),
-	/**
-	Creates a Scan object using the given details.
-	Raises an exception if no more of the given item can be scanned in against the purchase order of the given purchase.
-	*/
-	void scanIn(1:i64 purchaseId, 2:string itemNumber, 3:string imeiNumber, 4:ScanType type) throws (1:WarehouseServiceException wex),
-	/**
-	Marks the Scan object with the given details as scanned out. In case, the imeiNumber is not given,
-	marks the oldest ItemInventory object as being scanned out.
-	Raises an exception if:
-. There is no stock present corresponding to the given item details.
-. An older stock is present corresponding to the itemNumber which has not been scanned out.
-	*/
-	void scanOut(1:string itemNumber, 2:string imeiNumber, 3:ScanType type) throws (1:WarehouseServiceException wex)
-}
 struct Warehouse {
+:i64 id,
+:string displayName,
+:string location
+}
+struct InventoryItem {
+:i64 id,
+:i64 itemId,
+:string itemNumber,
+:string serialNumber,
+:i64 initialQuantity,
+:i64 currentQuantity,
+:i64 purchaseId
+}
+enum ScanType {
+    PURCHASE = 0,   // Scan-in at the time of purchase
+    SALE = 1,       // Scan-out for sale
+    SALE_RET = 2,   // Scan-in when an item is returned undelivered
+    DOA_IN = 3,     // Scan-in when an item is returned by the customer with the DOA certificate
+    DOA_OUT = 4,     // Scan-out to return an item to the supplier
+    PURCHASE_RETURN = 5 // Scan-out to return an item to the supplier (a Non-DOA case)
+}
+struct Scan {
+:i64 id,
+:i64 inventoryItemId,
+:optional i64 quantity, // ignored in case of serialized items
+:optional i64 orderId, // The order that was fulfilled with thin scan!
+:i64 warehouseId,
+:ScanType type,
+:i64 scannedAt
+}
+exception WarehouseServiceException {
+:GenericService.ExceptionType exceptionType,
+:string message
+}
+service WarehouseService extends GenericService.GenericService {
+    /**
+     * Creating inventory for a serialized item
+     */
+    i64 createSerializedInventoryItem(1:i64 itemId, 2:string serialNumber, 3:i64 purchaseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Creating inventory for a serialized item using item number
+     */
+    i64 createSerializedInventoryItemFromItemNumber(1:string itemNumber, 2:string serialNumber, 3:i64 purchaseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Creates inventory for an unserailized item
+     */
+    i64 createInventoryItem(1:i64 itemId, 2:i64 quantity, 3:i64 purchaseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Retrieves serialized inventory item given a serial number
+     */
+    InventoryItem getInventoryItem(1:string serialNumber);
+    /**
+     * Retrieves non-serialized inventory items from a given supplier
+     */
+    list<InventoryItem> getNonSeralizedInventoryItems(1:i64 itemId, 2:i64 quantity, 3:i64 supplierId);
+    /**
+     * Retrieves inventory items for a given item
+     */
+    list<InventoryItem> getInventoryItems(1:i64 itemId);
+    /**
+     * Retrieves scans for a given order
+     */
+    list<Scan> getScanForOrder(1:i64 orderId);
+    /**
+     * Retrieves scans for a given inventory item
+     */
+    list<Scan> getScan(1:i64 inventoryItemId);
+    /**
+     * Scan serialized items.
+     */
+    void scanSerializedItem(1:i64 inventoryItemId, 2:ScanType type, 3:i64 warehouseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Scan non-serialized items.
+     */
+    void scan(1:i64 inventoryItemId, 2:ScanType type, 3:i64 quantity, 4:i64 warehouseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Scan serialized items linked with an order. Returns its price.
+     */
+    i64 scanSerializedItemForOrder(1:i64 inventoryItemId, 2:ScanType type, 3:i64 orderId, 4:i64 warehouseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Scan non-serialized items linked with an order.
+     */
+    void scanForOrder(1:i64 inventoryItemId, 2:ScanType type, 3:i64 quantity, 4:i64 orderId, 5:i64 warehouseId) throws (1:WarehouseServiceException wex);
+    /**
+     * Created item number to item id mapping
+     */
+    void createItemNumberMapping(1:string itemNumber, 2:i64 itemId);
+}

Subversion Repositories SmartDukaan

(root)//trunk/ThriftGen/thriftsrc/WarehouseService/WarehouseService.thrift – Rev 3424 → 4496