Retail Item API
This topic describes the retail item APIs for the Integration Framework.
API
| Name | Description |
|---|---|
| void Delete(LogonInfo, RecordIdentifier) |
Delete a retail item. Parameters:
|
| void Get(LogonInfo, RecordIdentifier) |
Get a retail item. Parameters:
|
| void Save(LogonInfo, RetailItem) |
Save a retail item. Parameters:
|
| RetailItemSaveResult SaveList(LogonInfo, List<RetailItem>) |
Save multiple retail items. Parameters:
|
Business objects
The following business objects are used by the retail item API.
RetailItem
| Name | Description |
|---|---|
| BarCodeSetupDescription | The barcode setup description. This property is for viewing purposes only and will not be saved. |
| BarCodeSetupID | The selected barcode setup ID of the retail item. |
| BlockedOnPOS | If true, this item cannot be sold on the POS. |
| DateToActivateItem | The date after which the item is activated. An item cannot be sold on the POS until this date. |
| DateToBeBlocked | The date after which the item is blocked. An item cannot be sold on the POS after this date. |
| DefaultVendorID | The default vendor ID of the retail item. |
| Deleted | Get or set if the item is deleted. |
| Dirty | Set if the retail item is dirty. The item will not be saved if this property is not set to true. |
| ExtendedDescription | The long note field where notes about the item can be written. |
| HeaderItemID | Get or set the header item ID. |
| GradeID | The grade ID of a fuel item. |
| ID | The ID of the retail item. |
| InventoryExcluded | Indicates if item is deleted or is a service type item. Used in situations when items will not take part of the inventory. |
| InventoryUnitID | The inventory unit ID of the retail item. |
| InventoryUnitName | The description of inventory unit. This property is for viewing purposes only and will not be saved. |
| IsFuelItem | Get or set if the item is a fuel item. |
| IsHeaderItem | Returns true if the item is a header item. |
| IsRetailItem | Returns true if the item is a retail item. |
| IsServiceItem | Returns true if the item is a service item. |
| IsVariantItem | Returns true if the item is a variant item. |
| ItemType | Get or set the item type. Uses the ItemTypeEnum. |
| ItemTypeDescription | Get the description of the current item type. |
| KeyInPrice | Get or set how the price can be set when selling an item. Uses the KeyInPriceEnum. |
| KeyInQuantity | Get or set how the quantity can be set when selling an item. Uses the KeyInQuantityEnum. |
| KeyInSerialNumber | Get or set how the serial number can be set when selling an item. Uses the KeyInSerialNumberEnum. |
| MasterID | The unique identifier of the retail item. |
| MustKeyInComment | Get or set if a comment must be entered when selling the item. |
| MustSelectUOM | Get or set if the unit of measurement must be selected when selling the item. |
| NameAlias | The name alias of the item. |
| NoDiscountAllowed | Get or set discounts are not allowed on the item. |
| ProfitMargin | The profit margin of the item. |
| PurchasePrice | The purchase price based on the purchase unit. To compare it to SalesPrice, it must be recalculated using the sales unit. |
| PurchaseUnitID | The purchase unit ID of the item. |
| PurchaseUnitName | The description of the purchase unit. This property is for viewing purposes only and will not be saved. |
| QuantityBecomesNegative | Get or set if the quantity should become negative when the item is sold. |
| RetailDepartmentID | The ID of the retail department the item belongs to. This property is for viewing purposes only and will not be saved. |
| RetailDepartmentMasterID | The unique identifer of the retail department the item belongs to. |
| RetailDepartmentName | The retail department description. This property is for viewing purposes only and will not be saved. |
| RetailDivisionMasterID | The unique identifer of the retail division the item belongs to. |
| RetailDivisionName | The retail division description. This property is for viewing purposes only and will not be saved. |
| RetailGroupID | The ID of the retail group the item belongs to. This property is for viewing purposes only and will not be saved. |
| RetailGroupMasterID | The unique identifer of the retail group the item belongs to. |
| RetailGroupName | The retail group description. This property is for viewing purposes only and will not be saved. |
| Returnable | Get or set if this item can be returned on the POS. |
| SalesAllowTotalDiscount | Get or set if the item can be included in a total discount. |
| SalesLineDiscount | Get or set the sale line discount ID to which the item belogs to. |
| SalesLineDiscountName | The description of the line discount group. This property is for viewing purposes only and will not be saved. |
| SalesMarkup | The sales markup of the item. |
| SalesMultiLineDiscount | Get or set the sale multiline discount ID to which the item belogs to. |
| SalesMultiLineDiscountName | The description of the multiline discount group. This property is for viewing purposes only and will not be saved. |
| SalesPrice | The sales price base on the sales unit ID. |
| SalesPriceIncludingTax | The sales price base on the sales unit ID including tax. |
| SalesTaxItemGroupID | The ID of the tax group the item belongs to. |
| SalesTaxItemGroupName | The description of the sales tax group this item belongs to. This property is for viewing purposes only and will not be saved. |
| SalesUnitID | The sales unit ID of the item. |
| SalesUnitName | The description of the sales unit. This property is for viewing purposes only and will not be saved. |
| ScaleItem | Get or set if the item is a scale item and will get the quantity from a scale. |
| TaxItemGroupName | The description of the tax group. This property is for viewing purposes only and will not be saved. |
| Text | The name the retail item. |
| ValidationPeriodID | The ID of the validation period the item belongs to. |
| ValidationPeriodDescription | The description of the validation period. This property is for viewing purposes only and will not be saved. |
| VariantName | The variant name of the item. |
For a retail item object to be valid the ID, Text, InventoryUnitID and SalesUnitID properties must be set.
RetailItemsSaveResult
| Name | Description |
|---|---|
| RetailItemErrorInfo | A list of objects containing the retail items that failed the saving process along with the error message. |
| EndTime | The time at which the saving process finished. |
| StartTime | The time at which the saving process started. |
| Success | True if the saving process finished successfully. |
Examples
To update retail items you must use the optimized update feature.
Updating a retail item
RetailItem item = wcfRetailItemService.Get(CreateLogonInfo(dataModel), "0000001");
item.Text += "-Updated";
((IOptimizedUpdate) item).CloneUpdateListToTransportList();
wcfRetailItemService.Save(CreateLogonInfo(dataModel), item);
In the above example, firstly we get an existing retail item through the Integration Framework, update it, then we clone the update list using the optimized update functionality. After we update all properties accordingly we save the retail item through the Integration Framework.
Deleting a retail item
wcfRetailItemService.Delete(CreateLogonInfo(dataModel), "0000001");
