Interface ITmxPLU

Method name: put_ServerName

Short Description
Set the server name.
Stored Procedure
com_get_plu
Functionality
You typically call this method before other calls such as Inquiry and InquiryBatch.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
newVal	IN	VARIANT

Method name: Inquiry

Short Description
Searches for PLU codes in the database.
Stored Procedure
com_get_plu
Functionality
Search for a PLU record in the database based on the PLU number. SAP POS stores the first record it finds in memory for use by the function calls that follow, such as get_PluDescription. You can find a list of similar calls in TmxApi.tlh. There is a corresponding get method for every field in the table DBA.plu.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
PLU	IN	BSTR
SkuType	IN	SkuTypeEnum

Method name: InquiryBatch

Short Description
Runs a batch of PLU inquiries.
Stored Procedure
com_get_plu_batch
Functionality
Search for PLU records in the database based on the combination of the parameters Department, Group, Category, VendorID, and InventoryType. SAP POS stores the result in memory for use by the function calls that follow, such as MoveFirst, MoveLast, MovePrevious, and MoveNext. The result of the PLU record inquiry is output to the file with the name passed in FileName.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Department		VARIANT
Group		VARIANT
Category		VARIANT
VendorID		BSTR
FileName		BSTR
InventoryType		InventoryTypeEnum

Method name: GetCount

Short Description
Retrieves a number of PLU records.
Stored Procedure
com_get_plu_batch
Functionality
Similar to method InquiryBatch. SAP POS stores the result in memory to be accessed by calling function get_RecordsCount. You do not need to call GetCount if you have already called InquiryBatch.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Department		VARIANT
Group		VARIANT
Category		VARIANT
VendorID		BSTR
InventoryType		InventoryTypeEnum

Method name: MoveFirst

Short Description
Moves to the first PLU record.
Functionality
Move to the first record of the previous query result (InquiryBatch). SAP POS stores the result in memory where you can access it by calling such functions as get_PluDescription. You can find a list of similar calls in TmxApi.tlh. There is a corresponding get method for every field in the table DBA.plu.
Preconditions
- You must register TmxAPI.DLL.
- You must call InquiryBatch.
Result
HRESULT

Method name: Update

Short Description
Update the PLU record.
Stored Procedure
com_update_plu
Functionality
This method provides insert, update, and delete processing. When performing an insert, you should typically first call the methods Inquiry and one or more of the put_ methods, for example, put_PluDescription.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateType	IN	UpdateTypeEnum

Method name: UpdateBatch

Short Description
Update the PLU records.
Stored Procedure
com_update_plu
Functionality
This updates PLU records in batch mode based on the data contained in the input file FileName. Input is a comma delimited file with the following structure:
Syntax
Update type(1,2,3,4,5 or 99), plu num, old plu num, department id(int), plu description, retail price, mix match id1(int), tax1, tax2, link item flag, discountable, commission id(int), vendor ID, user flag 1, prompt id(int), family code(int), frequent buyer code(int), use depatment flag, scale item, return flag, coupon item,tax3,tax4, itemizrid1, itemizrid1 tax1, itemizrid1 tax2, itemizrid1 tax3, itemizrid1 tax4, active date, tare weight, has cross reference, has quantity price, has level price, mix match id 2, mix match id 3, mix match id 4, itemizrid2, itemizrid2 tax1, itemizrid2 tax2, itemizrid2 tax3, itemizrid2 tax4, itemizrid3, itemizrid3 tax1, itemizrid3 tax2, itemizrid3 tax3, itemizrid3 tax4, itemizrid4, itemizrid4 tax1, itemizrid4 tax2, itemizrid4 tax3, itemizrid4 tax4, verify when sold, quantity description, limited quantity, item size, allow employee discount, suggested retail price, user flag2, user flag3, user flag4, user flag5, user flag6, generate coupon ID(int), auto discount ID(int), filler1 (int), filler2 (int), filler3 (int), quantity required, sell quantity(int), allow on layaways, match MFG code, tax5,tax6, tax7, tax8, tax9,tax10, tax11, tax12, tax13, tax14, tax15, tax16, cost, competitice price1, competitice price2, vendor2, vendor3, sticker label ID(int) shelf label ID(int), inventory group ID, supplemental length, loyalty id 1, loyalty id 2, loyalty id 3, loyalty id 4, ordering number
End of the code.
There are a total of 96 fields. If you have no value for a specific field, default the field to N for string type fields and 0 for integer type fields.
Preconditions
You mist register TmxAPI.DLL.
Result
HRESULT



Parameter Name

Parameter Type

Data Type



FileName

IN

BSTR

Parameter Name	Parameter Type	Data Type
FileName	IN	BSTR


Method name: MoveLast
Short Description
Moves to the last PLU record.
Functionality
Move to the last record of the previous query result (InquiryBatch). SAP POS stores the result in memory where you can access it by calling such functions as get_PluDescription.
You can find a list of similar calls in TmxApi.tlh. There is a corresponding get method for every field in the table DBA.plu.
Preconditions
You must register TmxAPI.DLL.
You must call InquiryBatch.
Result
HRESULT


Method name: MovePrevious
Short Description
Moves to the previous PLU record.
Functionality
Move to the previous record of the current record set. The previous query result (InquiryBatch) provides the current record set.
Preconditions
You must register TmxAPI.DLL.
You must call InquiryBatch.
Result
HRESULT


Method name: MoveNext
Short Description
Moves to the next PLU record.
Functionality
Move to the next record of the current record set. The previous query result (InquiryBatch) provides the current record set.
Preconditions
You must register TmxAPI.DLL.
You must call InquiryBatch.
Result
HRESULT


Method name: put_CollectionFormat
Short Description
Construct the field list for use by the methods Inquiry and Inquiry Batch.
Stored Procedure
BSTR
Functionality
Call this method if you do not need all fields from the PLU record. You can select the fields you need from the PLU record from the following complete field list:
PluNumber,DepartmentNumber,PluDescription,RetailPrice,MixMatchID1,MixMatchID2,MixMatchID3,MixMatchID4,Tax1,Tax2,Tax3,Tax4,LinkItemFlag,AllowDiscount,CommissionID,VendorID1,ProcessPromptID,FamilyCode,FrequentBuyerCode,UseDepartmentFlag,UserFlagNumber1,UserFlagNumber2,UserFlagNumber3,UserFlagNumber4,UserFlagNumber5,UserFlagNumber6,ScaleItem,AllowReturn,CouponItem,TareWeightID,VerifyPlu,QuantityLimitID,PackageSize,SuggestedRetailPrice,GeneratedCouponID,QuantityRequired,SellQuantity,AllowLaysways,Cost,QuantityDescription,QuantityPricing,HasLevelPrice,MatchMFGCode,WasLocalPriceChanged,ItemizedID1,ItemizedID2,ItemizedID3,ItemizedID4,AllowEmployeeDiscount,StickerLabelNumber,ShelfLabelNumber,VendorID2,VendorID3,InventoryGroupID,CompetingPrice1,CompetingPrice2,SupplementalLengthID,LoyaltyID1,LoyaltyID2,LoyaltyID3,LoyaltyID4,AutoDiscountID,ItemizedID1Apply,Item1Tax1,Item1Tax2,Item1Tax3,Item1Tax4,ItemizedID2Apply,Item2Tax1,Item2Tax2,Item2Tax3,Item2Tax4,ItemizedID3Apply,Item3Tax1,Item3Tax2,Item3Tax3,Item3Tax4,ItemizedID4Apply,Item4Tax1,Item4Tax2,Item4Tax3,Item4Tax4,UserFlag1,UserFlag2,UserFlag3,UserFlag4,UserFlag5,UserFlag6,SizeUnit,OriginalPrice,PromoPrice,PromoNumber,PromoDescription
Preconditions
You must register TmxAPI.DLL.
You must call InquiryBatch.
Result
HRESULT


Parameter Name

Parameter Type

Data Type



newVa

IN

VARIANT