iVend POS - Objects Exposed via API

Introduction

This article contains the list of Objects which are exposed to the iVend API.

This article refers to the iVend Help file for all Objects, Operations, etc.

Overview

This section explains about the various Objects and their exposure to the iVend APIs, which are used while integrating to third party software.

In case multiple Objects are required to save data in a single business operation, then follow the calling sequence of the Objects in an order:

1. Country: Saves the country, use SaveCountry method.

2. State: Saves the state, use SaveState method.

3. Shipping Type: Saves the type of the shipping, use SaveShippingType method.

4. Currency: Saves the currency, use SaveCurrency method.

5. Exchange Rate: Saves the exchange rate, use SaveExchangeRate method.

6. Employee: Saves the employee, use SaveEmployee method.

7. Tax Code: Saves the tax code, use SaveTaxCode method.

8. Surcharge: Saves the surcharge, use SaveSurcharge method.

9. Manufacturer: Saves the manufacturer, use SaveManufacturer method.

10. Manufacturer Discount List:Saves the manufacturer discount list, use SaveManufacturerDiscountList method.

11. Warehouse: Saves the warehouse, use SaveWarehouse method.

12. Customer Group: Saves the customer group, use SaveCustomerGroup method.

13. Customer Group Discount List: Saves the customer group discount list, use SaveCustomerGroupDiscountList method.

14. Product Group: Saves the product group, use SaveProductGroup method.

15. Product Group Discount List: Saves the product group discount list, use SaveProductGroupDiscountList method.

16. Surcharges: Saves the surcharges defined for the product, use SaveProductSurcharges method.

17. Vendor: Saves the vendor, use method, use SaveVendor method.

18. Product: Saves the product, use method, use SaveProduct method.

19. Upsell Items: Sets the list of upsell items for the product, use SaveUpsellItems method.

20. Alternate Items: Saves the alternate items, use SaveAlternateItems method.

21. Alternate UPC: Save the list of alternate items for the product, use SaveAlternateUPC method.

22. Assembly Components: Defines the list of BOM components for the Assembly item, use SetAssemblyComponents method or use ProductAssemblyComponents list of the Product.

23. Kit Components: Defines the list of BOM components for the Kit item, use SetKitComponents method or use ProductKitComponents list of the Product.

24. Inventory Items: Save the warehouse wise properties of the product, use SaveInventoryItems method.

25. Price List: Saves the price list, use SavePriceList method.

26. Price Matrix: Saves the price matrix, use SavePriceMatrix method or use PriceMatrixList of Price List while saving Price List.

27. Customer: Saves the customer, use SaveCustomer method.

28. Customer Catalog:Saves the customer catalog, use SaveCustomerCatalog method.

29. Special Price: Saves the special price, use SaveSpecialPrice method.

30. Special Price Discount Group: Saves the special price discount group, use SaveSpecialPriceDiscountGroup method.

31. Save Inventory Updates: Saves the inventory updates. This will help the user to post the inventory deltas in iVend system, use SaveInventoryUpdate method.

32. Goods Receipt: Saves the goods receipt document, use SaveGoodsReceipt method.

33. Stock Transfer: Saves the stock transfer, use SaveStockTransfer method.

If you refer to the 'CXS.Retail.API Assembly->Namespaces->CXS.Retail.API Namespace->Classes->IntegrationService->Members' help page in the guide, it shows you all the available operation names which can be performed from the APIs.

Name	Description
Authenticate	Authenticates the specified device Id.
AuthorizePayment	Authorizes the payment.
AwardPoints	Reward the points on transaction.
CancelQuotation	Syncs the client data to server.
CancelSalesOrder	Syncs the client data to server.
CheckAPIConnection	To check API connection.
ClearAllInventory	Clears all the inventory of the warehouse from iVend. Should be used with caution.
DeleteAttribute	Deletes the attribute.
DeleteBarCodeMask	Deletes the Barcode Mask.
DeleteBatch	Deletes the Batch.
DeleteCountry	Deletes the country.
DeleteCoupon	Deletes the Coupon.
DeleteCurrency	Deletes the currency.
DeleteCustomer	Deletes the customer.
DeleteCustomerGroup	Deletes the customer group.
DeleteEmployee	Deletes the employee.
DeleteExchangeRateByDate	Deletes the exchange rate by date.
DeleteExchangeRateByDateAndCurrency	Deletes the exchange rate by date and currency.
DeleteGiftCertificateMaster	Deletes the gift certificate master.
DeleteManufacturer	Deletes the manufacturer.
DeletePaymentType	Deletes the Payment Type.
DeletePriceList	Deletes the price list.
DeleteProduct	Deletes the product.
DeleteProductGroup	Deletes the product group.
DeleteSerial	Deletes the Serial.
DeleteShippingType	Deletes the type of the shipping.
DeleteState	Deletes the state.
DeleteSurcharge	Deletes the surcharge.
DeleteTaxCode	Deletes the tax code.
DeleteTaxCodeCondition	Delete the Tax Condition Setup list.
DeleteUOM	Deletes the UOM.
DeleteUOMGroup	Deletes the UOM Group.
DeleteVendor	Deletes the vendor.
DeleteWarehouse	Deletes the warehouse.
ExecuteQueries	Executes the queries.
Get	Gets an Integration Queue with record details.
GetAccountsReceivable	Gets Accounts Receivable by customer Id
GetAllCountries	Gets All Countries
GetAllDeliveryPackage	Gets All delivery Packages
GetAllLineAttribute	Gets all the Line Attribute.
GetAllSaleAttribute	Gets all the Sale Attribute.
GetAllStates	Gets All States.
GetAttribute	Gets the Attribute.
GetBarCodeMask	Gets a Barcode Mask based on the id provided
GetBarCodeResolution	To get the Product of Barcode
GetBatch	Gets a Batch based on the id provided
GetCardSetupMethod	Gets Card Setup
GetCountry	Gets a country based on the id provided
GetCoupon	Gets a Coupon based on the id provided
GetCurrency	Gets the currency.
GetCustomer	Gets the customer.
GetCustomerGroup	Gets the customer group.
GetDeliveryPackageById	Gets Delivery Package
GetDeliveryPackageByKey	Gets Delivery Package
GetEmployee	Gets the employee.
GetExchangeRateByDate	Gets the exchange rate by date.
GetExchangeRateByDateAndCurrency	Gets the exchange rate by date and currency.
GetGiftCertificateMaster	Gets the Gift Certificate Master.
GetInventoryOfWarehouse	Gets the inventory of the products in a warehouse.
GetLineAttribute	Gets the Line Attribute.
GetLoyaltyLicenceDetails	Gets Loyalty Licence Details
GetManufacturer	Gets the manufacturer.
GetMobileSecurityRights	Gets the security rights.
GetMonthlyPointsSummary	Gets Monthly Points Summary by loyalty Id
GetNextNumber	Gets the next number.
GetPaymentType	Gets a Payment Type based on the id provided
GetPointsDetails	Gets Points Details by loyalty Id
GetPointsSummary	Gets Points Summary for Loyalty Id
GetPointsSummaryByTransactionKey	Gets Points Summary for Transaction Key
GetPrePrintedLoyaltyCards	Gets Pre Printed Loyalty Ids
GetPrePrintedLoyaltyCardsBySiteId	Gets the pre-printed loyalty cards for specific store.
GetPriceList	Gets the price list.
GetProduct	Gets the product.
GetProductCost	Gets Product Cost
GetProductGroup	Gets the product group.
GetProductImage	Gets the product Image.
GetProductUpgradeInformation	Gets Product Upgrade Information
GetQueryResult	Gets Query Result.
GetQueueByWarehouse	Gets an Integration Queue of a particular warehouse with its record details.
GetQueueOfEnterprise	Gets an Integration Queue of a Head Office with its record details.
GetRedeemableAmount	Gets redeemable amount by Loyalty Id
GetRegistrationMethod	Gets Registration Method
GetReplicationSendDump	Gets the Replication Send Dump for site.
GetReplicationStatus	Gets the replication status.
GetRetailProfileById	Gets the Retail Profile by ID.
GetSaleAttribute	Gets the Sale Attribute.
GetSerial	Gets a Serial based on the id provided
GetShippingType	Gets the type of the shipping.
GetState	Gets the state.
GetSurcharge	Gets the surcharge.
GetTaxCode	Gets the tax code.
GetTaxCodeConditions	Gets the List {TaxCodeCondition}.
GetTransaction	Gets a transaction based on key.
GetTransactionData	Gets a transaction data based on key.
GetUOM	Gets a UOM based on the id provided
GetUOMGroup	Gets a UOM Group based on the id provided
GetUpgradeInformation	Gets Upgrade Information
GetVendor	Gets the vendor.
GetVersionInformation	Gets Version Information
GetWarehouse	Gets the warehouse.
Initialize	Gets a Initialization Integration Queue of a mobile device with its record details.
PostFulfillment	Post fulfilment
Register	Registers the specified device with iVend API.
RegisterLoyaltyCustomer	To register loyalty customer information.
RemoveAlternateItems	Removes the alternate items.
RemoveAlternateUPC	Removes the list of alternate items for the product.
RemoveProductSurcharges	Removes the surcharges defined for the product.
RemoveUpsellItems	Removes the list of up-sell items for the product.
Save	Overloaded. Saves the updates to a specified master record. This method should be used in cases where only few properties on a master object is to be updated without affecting the other properties.
SaveAccountsReceivable	Overloaded. Save Accounts Receivable for customer
SaveAlternateItems	Saves the alternate items.
SaveAlternateUPC	Save the list of alternate items for the product.
SaveAttribute	Overloaded. Saves the attribute.
SaveBarCodeMask	Overloaded. Saves the Barcode Mask.
SaveBatch	Overloaded. Saves the Batch.
SaveCountry	Overloaded. Saves the country.
SaveCoupon	Overloaded. Saves the Coupon.
SaveCurrency	Overloaded. Saves the currency.
SaveCustomer	Overloaded. Saves the customer.
SaveCustomerCatalog	Saves the customer catalogue.
SaveCustomerGroup	Overloaded. Saves the customer group.
SaveCustomerGroupDiscountList	Saves the customer group discount list.
SaveEmployee	Overloaded. Saves the employee.
SaveExchangeRate	Overloaded. Saves the exchange rate.
SaveGiftCertificateMaster	Overloaded. Saves the Gift Certificate Master.
SaveGoodsIssue	Overloaded. Saves the goods Issue document.
SaveGoodsReceipt	Overloaded. Saves the goods receipt document.
SaveGoodsReceiptPO	Overloaded. Saves the goods receipt PO document.
SaveGoodsReturn	Overloaded. Saves the goods Return document.
SaveInventoryCounting	Sets the final inventory counting.
SaveInventoryItems	Save the warehouse wise properties of the product.
SaveInventoryUpdate	Saves the inventory updates. This will help the user to post the inventory deltas in iVend system.
SaveManufacturer	Overloaded. Saves the manufacturer.
SaveManufacturerDiscountList	Saves the manufacturer discount list.
SavePaymentType	Overloaded. Saves the Payment Type.
SavePriceList	Overloaded. Saves the price list.
SavePriceMatrix	Saves the price matrix.
SaveProduct	Overloaded. Saves the product.
SaveProductCost	Save the warehouse wise properties of the product.
SaveProductGroup	Overloaded. Saves the product group.
SaveProductGroupDiscountList	Saves the product group discount list.
SaveProductSurcharges	Saves the surcharges defined for the product.
SavePurchaseOrder	Overloaded. Saves the purchase order document.
SaveReplicationSendDumpList	Saves the Replication Send Dump List.
SaveSerial	Overloaded. Saves the Serial.
SaveShippingType	Overloaded. Saves the type of the shipping.
SaveSpecialPrice	Overloaded. Saves the special price.
SaveSpecialPriceDiscountGroup	Saves the special price discount group.
SaveState	Overloaded. Saves the state.
SaveStockTransfer	Overloaded. Saves the stock transfer.
SaveSurcharge	Overloaded. Saves the surcharge.
SaveTaxCode	Overloaded. Saves the tax code.
SaveTaxCodeCondition	Overloaded. Saves the Tax Condition Setup.
SaveTransaction	Posts the transaction within iVend.
SaveTransactionSignature	Syncs the client data to server.
SaveUOM	Overloaded. Saves the UOM.
SaveUOMGroup	Overloaded. Saves the UOM Group.
SaveUpsellItems	Sets the list of up-sell items for the product.
SaveVendor	Overloaded. Saves the vendor.
SaveVendorProductMapping	Saves the vendor product mapping.
SaveWarehouse	Overloaded. Saves the warehouse.
SearchTransaction	Gets a transaction list based on search criteria.
SetAssemblyComponents	Defines the list of BOM components for the Assembly item.
SetFinalInventory	Sets the final inventory of the items in a warehouse.
SetKitComponents	Defines the list of BOM components for the Kit item.
UpdateGiftCertificateBalance	Update the balance on the Gift Certificate.
UpdateLoyaltyCustomer	To update loyalty customer information.
UpdateReplicationSentStatus	Update replication status.
UpdateSynchronizationStatus	Update the data synchronization status for device.
ValidateLoyaltyCustomer	Validate the Loyalty Customer
ValidateLoyaltyPortalCustomer	Validate the Loyalty Portal Customer
ValidateUser	Overloaded. Validate User Id and Password

Each operation mentioned above will either return or takes a business object. The table below lists the Objects which can be further referred to in the help file at "CXS.Retail.DTO Assembly->Namespaces->CXS.Retail.DTO Namespaces->Classes" help page:

· AccountReceivableDTO

· AddressDTO

· AddressDTOList

· AlternateItemDTO

· ARPaymentItemDTOList

· AttributeDTO

· AttributeDTOList

· AttributeMasterDTO

· AttriibuteValidValueDTO

· AttributeValidValueDTOList

· AuthorizePaymentDTO

· AuthoriizePaymentResponseDTO

· BarCodeMaskDetailDTO

· BarCodeMaskDetailDTOList

· BarCodeMaskDTO

· BaseDTO

· BatchDTO

· ChildProductDTO

· Constants

· CountryDTO

· CouponDTO

· CurrencyDenominationDTO

· CurrencyDenominationDTOList

· CurrencyDTO

· CustomerAddressDTO

· CustomerBranchDTO

· CustomerCatalogDetailDTO

· CustomerCatalogDetailDTOList

· CustomerCatalogDTO

· CuustomerDTO

· CustomerGroupDiscountDTO

· CustomerGroupDTO

· CustomerSummaryDTO

· CustomTransactionInfoGridDetailDTO

· CustomTransationInfoGridDTO

· DeliveryPackageAddressDTO

· DeliveryPackageDTO

· DepartmentDTO

· DiscountGroupDTO

· EmployeeDTO

· EmployeePositionDTO

· EnterpriseDTO

· EventDTO

· ExchangeRateDTO

· FulfillmentPlanDTO

· FulfillmentPlanSurchargeDTO

· FulfillmentPlanSurchargeDTOList

· GiftCertiificateDTO

· GiftCertificateMasterDTO

· GoodsIssueBatchDetailDTO

· GoodsIssueBatchDetailDTOList

· GoodsIssueDetailDTO

· GoodsIssueDetailDTOList

· GoodIIssueDTO

· GoodsIssueSerialDetailDTO

· GoodsIssueSerialDetailDTOList

· GoodsReceiptBatchDetailDTO

· GoodsReceiptBatchDetailDTOList

· GoodsReceiptDetailDTO

· GoodsReceiptDetaiilDTOList

· GoodsReceiptDTO

· GoodsReceiptPOBatchDetailDTO

· GoodsReceiptPOBatchDetailDTOList

· GoodsReceiptPODetailDTO

· GoodsReceiptPODetailDTOList

· GoodsReceiptPODTO

· GoodsReceiptPOSerialDetailDTO

· GoodsReceiptPOSerialDetailDTOList

· GoodsReceipptSerialDetailDTO

· GoodsReceiptSeriialDetailDTOList

· GoodsReturnBatchDetailDTO

· GoodsReturnBatchDetailDTOList

· GoodsReturnDetailDTO

· GoodsReturnDetailDTOList

· GoodsReturnDTO

· GoodsReturnSerialDetailDTO

· GoodsReturnSerialDetailDTOList

· HistoricalSalesDTO

· IntegrationQueueDTO

· InventoryCountBatchDetailDTO

· InventoryCountBatchDetailDTOList

· InventoryCountDetailDTO

· InventoryCountDetailDTOList

· InventoryCountDTO

· InventooryCountSerialDetailDTO

· InventooryCountSerialDetailDTOList

· InventoryItemDTO

· InventoryItemDTOList

· InventooryItemExcelDTO

· InventoryUpdateBatchDTO

· InventoryUpdateBatchDTOList

· IInventoryUpdateDTO

· InvenrotyUpdateSerialDTO

· InventoryUpdateSerialDTOList

· JobCodeDTO

· LayawayPlanDTO

· LayawayPlanSurchargeDTO

· LayawayPLanSurchargeDTOList

· LineAttributeDTO

· LoyaltyCardInformationDTO

· LoyaltyPrePrintedCardsDTO

· LoyaltySetupDTO

· MandatoryMappingAttribute

· ManufactureDTO

· ManufacturerFroupDiscountDTO

· MessageDTO

· NumberSeriesMasterDTO

· NumberSeriesMasterExcelDTO

· PaymentCollectionDetaiilDTO

· PaymentColllectionDetailDTOList

· PaymentCollectionDTO

· PaymentTypeAttributeDTO

· PaymentTypeAttributeDTOLiist

· PaymentTypeDiscountDTO

· PaymentTypeDiscountDTOList

· PaymentTypeDTO

· PaymentTypeSurchargeDTO

· PaymentTypeSurchargeDTOList

· POSDTO

· PostDeliveryDTO

· PostDeliveryItemDTO

· PostDeliveryItemDTOList

· PostTransactionDTO

· PostTransactionItemDTOList

· PostTransactionLineItemAttributeDTO

· PostTransactionLineItenAttributeDTOList

· PriceListDTO

· PriceMatrixDTO

· PriceMatrixDTOList

· PriceUOMMatrixDTOList

· ProductBOMDTO

· ProductBOMDTOList

· ProductCategoryDTO

· ProductClassDTO

· ProductCostDTO

· ProductDTO

· ProductGroupDiscountDTO

· ProductGroupDTO

· ProductImageDTO

· ProductMerchandiseHierarchyDetailDTO

· ProductMerchandiseHierarchyDetailDTOList

· ProductUpsellDTO

· PropertyCaptionSetupDTO

· PropertyDTO

· PropertyDTOOList

· PurchaseOrderDetailDTO

· PurchaseOrderDetailDTOList

· PurchaseOrderDTO

· PurchaseOrderSurchargeDTO

· PurchaseOrderSurchargeDTOList

· ReasonCodeDTO

· ReplicationSendDumpDTO

· RetailProfileDTO

· SaleAtributeDTO

· SecurityRightsDTO

· SecurityUserDTO

· SerialDTO

· ShippingTypeDTO

· SpecialPriceDiscountGroupDTO

· SpecialPriceListDateDTO

· SpecialPriceListDateDTOList

· SpeciialPriceListDTO

· SpecialPriceListExcellmportDTO

· SpecialPriceListQuantityDTO

· SpecialPriceListQuantityDTOList

· StateDTO

· StockTransferBatchDetailDTO

· StockTransferBatchDetailDTOList

· StockTransferDetailDTO

· StockTransferDetailDTOList

· StockTransferDTO

· StockTransferRequestDetailDTOLiist

· StockTransferRequisitionDetailDTO

· StockTransferRequisitionDTO

· StockTransferSerialDetailDTO

· StockTransferSerialDetailDTOList

· StoreDTO

· StoreExpenseDTO

· SurchargeDTO

· TaxCodeDTO

· TaxCodeExcellmportDTO

· TaxPeriodDifinitionDTO

· TaxPeriodDefinitionDTOList

· TeamDTO

· TransactionDTO

· TransactionImportDTO

· TransactionItemDTO

· TransactionItemDTOList

· TransactionPaymentAttributeDTO

· TransactionPaymentAttributeDTOList

· TransactionPaymentDTO

· TransactionPaymentDTOList

· TransactionPrintingDTO

· TransactionSalesPersonDTO

· TransactionSalesPersonDTOList

· TransactioonSurchargeDTO

· TransactionSurchargeDTOList

· UUOMDTO

· UOMGroupDTO

· UpdateMasterDTO

· UpsellProductDTO

· UserDefinedFieldsValidValidValueDTO

· UserFieldsDTO

· UserFieldsDTOList

· VendorAddressDTO

· VendorDTO

· VendorExcellmportDTO

· VendorProductMappingDTO

· VendorProductMappingDTOList

· WarehouseDTO

· ZIPCodeDTO

· ProductSalesPersonDTO

· ProductSurchargeDTO

You can refer to individual DTO Object members for all exposed public properties for programming purposes.

Related Articles
Creating UDT via API
Introduction iVend Add-on Framework is used for writing Custom Business Logic independently by a programmer. iVend Addon allows to extend business logic either in Management Console or at the Terminal POS.The addon framework allows deployment of ...
Creating UDT via API
Introduction: iVend Add-on Framework is used for writing Custom Business Logic independently by a programmer. iVend Addon allows to extend business logic either in Management Console or at the Terminal POS. The addon framework allows deployment of ...
Customer unable to do refund invoices in one site due to API Url not working at this showroom
Environment: iVend 6.6 Problem Statement: Customer unable to do refund invoices in one site and getting the error attached at below Error Screenshot: Issue steps : 1. Open POS and press transaction search 2. Search with transaction SA0222000468 3. ...
Handling iVend Retail Business Objects
Introduction This knowledge base article will assist developers on how to handle iVend Retail Business Objects when using various events exposed in the iVend Management Console and the iVend POS. Purpose As an example, a developer can use iVend ...
iVend POS Consume API
How to consume an iVend API This article provides an overview about how to consume and use an iVend API. Overview iVend APIs are used to help integrate iVend with third party ERP applications such as; SAP Business One, SAP R3, Microsoft Dynamics ...

iVend POS - Objects Exposed via API

iVend POS - Objects Exposed via API

Introduction

Overview

Related Articles

Creating UDT via API

Creating UDT via API

Customer unable to do refund invoices in one site due to API Url not working at this showroom

Handling iVend Retail Business Objects

iVend POS Consume API