IntegrationService Class Members

<< Click to Display Table of Contents >>

Navigation:  CXS.Retail.API Assembly > Namespaces > CXS.Retail.API Namespace > Classes > IntegrationService >

IntegrationService Class Members

Navigation:  CXS.Retail.API Assembly > Namespaces > CXS.Retail.API Namespace > Classes > IntegrationService >

hm_btn_navigate_prevhm_btn_navigate_tophm_btn_navigate_next

iVend Retail 6.6 - Web API Help

IntegrationService Class Members

Methods  Collapse All Expand All Members Options: Show All Members Options: Filtered

[TCheckBoxFormControlObj] Include Inherited Members

[TCheckBoxFormControlObj] Include Protected Members

CXS.Retail.API Namespace : IntegrationService Class

The following tables list the members exposed by IntegrationService.

Public Constructors

 

Name

Description

Public Constructor

IntegrationService Constructor

 

Top

Public Methods

 

Name

Description

Public Method

Authenticate

Authenticates the specified deviceId.  

Public Method

AuthorizePayment

Authorizes the payment.  

Public Method

AwardPoints

Reward the points on transaction.  

Public Method

AwardPointsOnPormotion

Awards the extra loyalty points on a transaction which are setup as part of the promotion  

Public Method

CancelQuotation

Syncs the client data to server.  

Public Method

CancelSalesOrder

Syncs the client data to server.  

Public Method

CancelStockTransfer

Cancel Stock Transfer  

Public Method

CheckAPIConnection

To check API connection.  

Public Method

CheckInitializationStatus

Check Initialization status for mobile device.  

Public Method

ClearAllInventory

Clears all the inventory of the warehouse from iVend. Should be used with caution.  

Public Method

ClearAllInventoryFromWarehouseLocation

Clears all the inventory of the warehouse location from iVend. Should be used with caution. This method should be used when location is enabled on warehouse.  

Public Method

CreateUserDefinedField

Creates the user defined field.  

Public Method

DeAssignProductsFromProductCategory

Removes product(s) from the ProductCategory.  

Public Method

DeleteAttribute

Deletes the attribute.  

Public Method

DeleteBank

Deletes the Bank.  

Public Method

DeleteBarCodeMask

Deletes the BarCodeMask.  

Public Method

DeleteCountry

Deletes the country.  

Public Method

DeleteCoupon

Deletes the Coupon.  

Public Method

DeleteCurrency

Deletes the currency.  

Public Method

DeleteCustomer

Deletes the customer.  

Public Method

DeleteCustomerCatalog

Overloaded.  Deletes the customer catalog for individual customer.  

Public Method

DeleteCustomerDiscountGroup

Deletes the CustomerDiscountGroup.  

Public Method

DeleteCustomerGroup

Deletes the customer group.  

Public Method

DeleteCustomerPriceGroup

Deletes the CustomerPriceGroup.  

Public Method

DeleteEmployee

Deletes the employee (sales Person).  

Public Method

DeleteExchangeRateByDate

Deletes the exchange rate by date.  

Public Method

DeleteExchangeRateByDateAndCurrency

Deletes the exchange rate by date and currency.  

Public Method

DeleteGiftCertificateMaster

Deletes the gift certificate master.  

Public Method

DeleteLineDiscountGroup

Deletes the Line Discount Group.  

Public Method

DeleteManufacturer

Deletes the manufacturer.  

Public Method

DeletePaymentType

Deletes the PaymentType.  

Public Method

DeletePriceList

Deletes the price list.  

Public Method

DeleteProduct

Deletes the product.  

Public Method

DeleteProductCategory

Deletes the ProductCategory.  

Public Method

DeleteProductClass

Deletes the ProductClass.  

Public Method

DeleteProductDiscountGroup

Deletes the ProductDiscountGroup.  

Public Method

DeleteProductGroup

Deletes the product group.  

Public Method

DeletePromotionalBonusBuys

Deletes the Promotion Bonus Buys  

Public Method

DeletePurchasePrice

Deletes the Purchase Price.  

Public Method

DeleteReasonCode

Deletes the ResonCode.  

Public Method

DeleteSalesPrice

Deletes the Sales Price.  

Public Method

DeleteSerial

Deletes the Serial.  

Public Method

DeleteShippingType

Deletes the type of the shipping.  

Public Method

DeleteState

Deletes the state.  

Public Method

DeleteStoreGroup

Deletes the Store group.  

Public Method

DeleteSurcharge

Deletes the surcharge.  

Public Method

DeleteSuspendedTransaction

Deletes the suspended transaction.  

Public Method

DeleteTaxCode

Deletes the tax code.  

Public Method

DeleteTaxCodeCondition

Delete the Tax Condition Setup list.  

Public Method

DeleteUDTRow

Deletes the specified row from user defined table.  

Public Method

DeleteUOM

Deletes the UOM.  

Public Method

DeleteUOMGroup

Deletes the UOM Group.  

Public Method

DeleteVendor

Deletes the vendor.  

Public Method

DeleteVendorGroup

Deletes the vendor group.  

Public Method

DeleteWarehouse

Deletes the warehouse.  

Public Method

DoElectricLogin

Overloaded.  

Public Method

ExecuteQueries

Executes the queries.  

Public Method

FetchQueryResult

Get Result of a query.  

Public Method

GetAccountsReceivable

Get AccountsReceivable by customer Id  

Public Method

GetAccountsReceivableSubsidiaryWise

Get AccountsReceivable by CustomerId and SubsidiaryId  

Public Method

GetAllBanks

Get All Banks  

Public Method

GetAllCountries

Get All Countries  

Public Method

GetAllCustomerDiscountGroups

Get All Customer Discount Groups  

Public Method

GetAllCustomerPriceGroups

Get All Customer Price Groups  

Public Method

GetAllDeliveryPackage

Get All delivery Packages  

Public Method

GetAllLineAttribute

Gets all the Line Attribute.  

Public Method

GetAllLoyaltySetup

Get All Loyalty Setup  

Public Method

GetAllProductDiscountGroups

Get All Product Discount Groups  

Public Method

GetAllReasonCode

Gets all reason code.  

Public Method

GetAllSaleAttribute

Gets all the Sale Attribute.  

Public Method

GetAllStates

Get All States.  

Public Method

GetAllStores

Get All Stores  

Public Method

GetAttribute

Gets the Attribute.  

Public Method

GetAttributeByKey

Gets the attribute with all childs.  

Public Method

GetBank

Gets a Bank based on the id provided  

Public Method

GetBarCodeMask

Gets a BarCodeMask based on the id provided  

Public Method

GetBarCodeResolution

Overloaded.  To get the Product of BarCode  

Public Method

GetBarCodeResolutionWithType

To get the Product of BarCode  

Public Method

GetCardSetupMethod

Get Card Setup  

Public Method

GetCountry

Gets a country based on the id provided  

Public Method

GetCoupon

Gets a Coupon based on the id provided  

Public Method

GetCurrency

Gets the currency.  

Public Method

GetCustomer

Gets the customer.  

Public Method

GetCustomerDiscountGroup

Gets a Customer Discount Group based on the id provided  

Public Method

GetCustomerGroup

Gets the customer group.  

Public Method

GetCustomerPriceGroup

Gets a Customer Price Group based on the id provided  

Public Method

GetDeliveryPackageById

Get Delivery Package  

Public Method

GetDeliveryPackageByKey

Get Delivery Package  

Public Method

GetDeltaInventoryUpdates

 

Public Method

GetEmployee

Gets the employee.  

Public Method

GetEnterprise

Gets the enterprise.  

Public Method

GetExchangeRateByDate

Gets the exchange rate by date.  

Public Method

GetExchangeRateByDateAndCurrency

Gets the exchange rate by date and currency.  

Public Method

GetGiftCertificateMaster

Gets the Gift Certificate Master.  

Public Method

GetInventoryOfProduct

Gets the inventory of product.  

Public Method

GetInventoryOfWarehouse

Gets the invnetory of the products in a warehouse.  

Public Method

GetItemSalesPrice

Returns the sales price of an item.  

Public Method

GetLineAttribute

Gets the Line Attribute.  

Public Method

GetLineDiscountGroup

Gets the Line DiscountGroup.  

Public Method

GetLocation

Gets Location  

Public Method

GetLocationStockTransfer

Saves the location stock transfer.  

Public Method

GetLoyaltyLicenceDetails

GetLoyaltyLicenceDetails  

Public Method

GetLoyaltyPortalLicenceDetails

GetLoyaltyLicenceDetails  

Public Method

GetLoyaltySetup

Get Loyalty Setup by LoyaltySetupId  

Public Method

GetManufacturer

Gets the manufacturer.  

Public Method

GetMerchandiseHierarchy

Get the Merchandise Hierarchy.  

Public Method

GetMonthlyPointsSummary

Get Monthly Points Summary by loyaltyId  

Public Method

GetNextNumber

Gets the next number.  

Public Method

GetPaymentType

Gets a PaymentType based on the id provided  

Public Method

GetPicking

 

Public Method

GetPickings

 

Public Method

GetPointsDetails

Get Points Details by loyaltyId  

Public Method

GetPointsDetailsForPortalIntegration

Get Points Summary for Loyalty Id  

Public Method

GetPointsSummary

Get Points Summary for Loyalty Id  

Public Method

GetPointsSummaryByTransactionKey

Get Points Summary for Transaction Key  

Public Method

GetPointsSummaryForPortalIntegration

Get Loyalty Points Summary for For Portal Integration  

Public Method

GetPrePrintedLoyaltyCards

Get Pre Printed Loyalty Ids  

Public Method

GetPrePrintedLoyaltyCardsBySiteId

Gets the pre printed loyalty cards for specific store.  

Public Method

GetPriceList

Gets the price list.  

Public Method

GetProduct

Gets the product.  

Public Method

GetProductByVariantCode

Gets the product on variant Code.  

Public Method

GetProductCategory

Gets the ProductCategory.  

Public Method

GetProductClass

Gets the ProductClass.  

Public Method

GetProductCost

Get Product Cost  

Public Method

GetProductDiscountGroup

Gets a Product Discount Group based on the id provided  

Public Method

GetProductGroup

Gets the product group.  

Public Method

GetProductImage

Gets the product Image.  

Public Method

GetProductUpgradeInformation

Get Product Upgrade Information  

Public Method

GetPromotionBonusBuys

Gets promotion Bonus Buys  

Public Method

GetPurchaseOrderById

Gets the purchase order by identifier.  

Public Method

GetPurchaseOrderByKey

Gets the purchase order by key.  

Public Method

GetQueryResult

Get Query Result.  

Public Method

GetQueue

Gets a Integration Queue with record details.  

Public Method

GetQueueByWarehouse

Gets a Integration Queue of a particular warehouse with its record details.  

Public Method

GetQueueByWarehouseWithoutStatusUpdate

Gets a Integration Queue of a particular warehouse with its record details.  

Public Method

GetQueueOfEnterprise

Gets a Integration Queue of a Head Office with its record details.  

Public Method

GetQueueOfEnterpriseWithoutStatusUpdate

Gets a Integration Queue of a Head Office with its record details.  

Public Method

GetQueueWithoutStatusUpdate

Gets a Integration Queue with record details.  

Public Method

GetReasonCode

Get the reason code based on the id provided  

Public Method

GetRedeemableAmount

Get redeemable amount by Loyalty Id  

Public Method

GetRegistrationMethod

Get Registration Method  

Public Method

GetReplicationSendDump

Get the ReplicationSendDump for site.  

Public Method

GetReplicationStatus

Get the replication status.  

Public Method

GetRetailProfileById

Gets the Retail Profile by ID.  

Public Method

GetSaleAttribute

Gets the Sale Attribute.  

Public Method

GetSalesPrice

Gets the Sales Price.  

Public Method

GetSerial

Deletes the Batch.  

Public Method

GetShippingType

Gets the type of the shipping.  

Public Method

GetSpecialPriceList

Returns a DataTable with Special Price List  

Public Method

GetState

Gets the state.  

Public Method

GetStockTransferRequest

Get the stock transfer detail of given stock transfer key  

Public Method

GetStore

Gets a store based on the id provided  

Public Method

GetStoreGroup

Gets the Store group.  

Public Method

GetSubsidiary

Gets Subsidiary  

Public Method

GetSurcharge

Gets the surcharge.  

Public Method

GetTaxCode

Gets the tax code.  

Public Method

GetTaxCodeConditions

Gets the List{TaxCodeCondition}.  

Public Method

GetTransaction

Gets a transaction based on key.  

Public Method

GetTransactionData

Gets a transaction data based on key.  

Public Method

GetTransactionDeliveryInformation

Gets the transaction delivery information.  

Public Method

GetTransactionDetailForPortalIntegration

Get Transaction Detail for Transaction Key and no any point detail  

Public Method

GetTransactionItemDetails

Gets the transaction item details.  

Public Method

GetTransactionStatus

Gets the balance information of the transaction by passing the transaction id  

Public Method

GetUDTData

Gets all data from specified user defined table.  

Public Method

GetUDTRowData

Gets the specified row from a user defined table.  

Public Method

GetUOM

Gets a UOM based on the id provided  

Public Method

GetUOMGroup

Gets a UOMGroup based on the id provided  

Public Method

GetUpgradeInformation

Get Upgrade Information  

Public Method

GetUserDefinedFields

Gets the user defined fields.  

Public Method

GetVendor

Gets the vendor.  

Public Method

GetVendorByKey

 

Public Method

GetVendorGroup

Gets the Vendor group.  

Public Method

GetVersionInformation

Get Version Information  

Public Method

GetWarehouse

Gets the warehouse.  

Public Method

InitializeByScript

Gets a Initialization Integration Queue of a mobile device with its record details.  

Public Method

MarkCustomerGDPR

Mark Customer GDPR.  

Public Method

PostFulfillment

Post fulfillment  

Public Method

PrintItemLabels

 

Public Method

Register

Registers the specified device with iVend API.  

Public Method

RegisterLoyaltyCustomer

To register loyalty customer information.  

Public Method

RemoveAlternateItems

Removes the alternate items.  

Public Method

RemoveAlternateUPC

Removes the list of alternate items for the product.  

Public Method

RemoveAlternateUPCFromProduct

 

Public Method

RemoveProductSurcharges

Removes the surcharges defined for the product.  

Public Method

RemoveUpsellItems

Removes the list of up-sell items for the product.  

Public Method

ReplicatePortalLoyaltyCustomerInformationToiVend

Replicate Portal Loyalty Customer Information To iVend.  

Public Method

RollBackRedeemedPoints

Rolls the back redeemed points.  

Public Method

SaleOrderClose

Close the SaleOrder .  

Public Method

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.  

Public Method

SaveAccountsReceivable

Overloaded.  Save Accounts Receivable for customer  

Public Method

SaveAlternateItems

Saves the alternate items.  

Public Method

SaveAlternateUPC

Save the list of alternate items for the product.  

Public Method

SaveAttribute

Overloaded.  Saves the attribute.  

Public Method

SaveBank

Overloaded.  Saves the Bank.  

Public Method

SaveBarCodeMask

Overloaded.  Saves the BarCodeMask.  

Public Method

SaveBatch

Overloaded.  Gets a Batch based on the id provided  

Public Method

SaveCountry

Overloaded.  Saves the country.  

Public Method

SaveCoupon

Overloaded.  Saves the Coupon.  

Public Method

SaveCurrency

Overloaded.  Saves the currency.  

Public Method

SaveCustomer

Overloaded.  Saves the customer.  

Public Method

SaveCustomerCatalog

Saves the customer catalog.  

Public Method

SaveCustomerDiscountGroup

Overloaded.  Saves the CustomerDiscountGroup.  

Public Method

SaveCustomerGroup

Overloaded.  Saves the customer group.  

Public Method

SaveCustomerGroupDiscountList

Saves the customer group discount list.  

Public Method

SaveCustomerPriceGroup

Overloaded.  Saves the CustomerPriceGroup.  

Public Method

SaveEmployee

Overloaded.  Saves the employee.  

Public Method

SaveExchangeRate

Overloaded.  Saves the exchange rate.  

Public Method

SaveGiftCertificateMaster

Overloaded.  Saves the Gift Certificate Master.  

Public Method

SaveGoodsIssue

Overloaded.  Saves the goods Issue document.  

Public Method

SaveGoodsReceipt

Overloaded.  Saves the goods receipt document.  

Public Method

SaveGoodsReceiptPO

Overloaded.  Saves the goods receipt PO document.  

Public Method

SaveGoodsReceiptStockTransfer

Overloaded.  

Public Method

SaveGoodsReturn

Overloaded.  Saves the goods Return document.  

Public Method

SaveIncomingIntegrationLog

Save the incoming integration record information. This is used when a registered application is sending its queue information to iVend.  

Public Method

SaveInventoryCounting

Sets the final inventory counting.  

Public Method

SaveInventoryItems

Save the warehouse wise properties of the product.  

Public Method

SaveInventoryUpdate

Saves the inventory updates. This will help the user to post the inventory deltas in iVend system.  

Public Method

SaveLineDiscountGroup

Overloaded.  Saves the LineDiscountGroupDTO.  

Public Method

SaveLocation

Overloaded.  Save the Location  

Public Method

SaveLocationStockTransfer

Overloaded.  Saves the location stock transfer.  

Public Method

SaveLoyaltyAdjustmentJournal

Overloaded.  Saves the Loyalty Adjustment Journal.  

Public Method

SaveLoyaltyTransaction

Posts the transaction within iVend.  

Public Method

SaveManufacturer

Overloaded.  Saves the manufacturer.  

Public Method

SaveManufacturerDiscountList

Saves the manufacturer discount list.  

Public Method

SaveMerchandiseHierarchy

 

Public Method

SavePaymentType

Overloaded.  Saves the PaymentType.  

Public Method

SavePicking

 

Public Method

SavePriceList

Overloaded.  Saves the price list.  

Public Method

SavePriceMatrix

Saves the price matrix.  

Public Method

SaveProduct

Overloaded.  Saves the product.  

Public Method

SaveProductCategory

Overloaded.  Saves the ProductCategory.  

Public Method

SaveProductClass

Overloaded.  Saves the AccountsReceivable.  

Public Method

SaveProductCost

Save the warehouse wise properties of the product.  

Public Method

SaveProductDiscountGroup

Overloaded.  Saves the ProductDiscountGroup.  

Public Method

SaveProductGroup

Overloaded.  Saves the product group.  

Public Method

SaveProductGroupDiscountList

Saves the product group discount list.  

Public Method

SaveProductImage

 

Public Method

SaveProductMerchandiseHierarchy

Save the Product MerchandiseHierarchy.  

Public Method

SaveProductSurcharges

Saves the surcharges defined for the product.  

Public Method

SaveProductVariant

To save Product Variant  

Public Method

SavePromotionalBonusBuys

Overloaded.  Save the promotion Bonus Buys  

Public Method

SavePurchaseOrder

Get the good reciept on the basis of GoodReceiptkey  

Public Method

SavePurchaseOrderList

Saves the purchase order list.  

Public Method

SavePurchasePrice

Overloaded.  Saves the PurchasePriceDTO.  

Public Method

SaveReasonCode

Saves the ReasonCode.  

Public Method

SaveReasonCodeList

Saves the ResonCode.  

Public Method

SaveRegisteredApplication

 

Public Method

SaveReplicationSendDumpList

Saves the Replication Send Dump List.  

Public Method

SaveSalesPrice

Overloaded.  Saves the SalesPriceDTO.  

Public Method

SaveSerial

Overloaded.  Saves the Serial.  

Public Method

SaveShippingType

Overloaded.  Saves the type of the shipping.  

Public Method

SaveSpecialPrice

Overloaded.  Saves the special price.  

Public Method

SaveSpecialPriceDiscountGroup

Saves the special price discount group.  

Public Method

SaveState

Overloaded.  Saves the state.  

Public Method

SaveStockTransfer

Overloaded.  Saves the stock transfer.  

Public Method

SaveStockTransferRequest

Overloaded.  Saves the Stock transfer Request object  

Public Method

SaveStore

Overloaded.  Saves the store.  

Public Method

SaveStoreGroup

Overloaded.  Saves the Store group.  

Public Method

SaveSubsidiary

Overloaded.  Save Subsidiary.  

Public Method

SaveSurcharge

Overloaded.  Saves the surcharge.  

Public Method

SaveTaxCode

Overloaded.  Saves the tax code.  

Public Method

SaveTaxCodeCondition

Overloaded.  Saves the Tax Condition Setup.  

Public Method

SaveTransaction

Posts the transaction within iVend.  

Public Method

SaveTransactionDeliveryInformation

Saves the transaction delivery information.  

Public Method

SaveTransactionSignature

Syncs the client data to server.  

Public Method

SaveUDTData

Saves the udt data.  

Public Method

SaveUOM

Overloaded.  Saves the UOM.  

Public Method

SaveUOMGroup

Overloaded.  Saves the UOMGroup.  

Public Method

SaveUpsellItems

Sets the list of up-sell items for the product.  

Public Method

SaveVendor

Overloaded.  Saves the vendor.  

Public Method

SaveVendorGroup

Overloaded.  Saves the Vendor group.  

Public Method

SaveVendorProductMapping

Saves the vendor product mapping.  

Public Method

SaveWarehouse

Overloaded.  Saves the warehouse.  

Public Method

SearchTransaction

Gets a transaction list based on search criteria.  

Public Method

SetAssemblyComponents

Defines the list of BOM components for the Assembly item.  

Public Method

SetFinalInventory

Sets the final inventory of the items in a warehouse.  

Public Method

SetKitComponents

Defines the list of BOM components for the Kit item.  

Public Method

UpdateGiftCertificateBalance

Update the balance on the Gift Certificate.  

Public Method

UpdateIntegrationQueueStatus

 

Public Method

UpdateLoyaltyCustomer

To update loyalty customer information.  

Public Method

UpdateRecordsStatus

Update the status of records.  

Public Method

UpdateReplicationSentStatus

Update replication status.  

Public Method

UpdateSynchronizationStatus

Update the data synchronization status for device.  

Public Method

UpdateTransactionBalance

Updates the balance amout of the transaction  

Public Method

ValidateLicense

 

Public Method

ValidateLicenseForIntegration

Validates the license for integration.  

Public Method

ValidateLoyaltyCustomer

Validate the Loyalty Customer  

Public Method

ValidateLoyaltyPortalCustomer

Validate the Loyalty Portal Customer  

Public Method

ValidateUser

Overloaded.  Validate User Id and Password  

Public Method

X_AuthorizePayment

XML Based Authorize Transaction Payment.  

Public Method

X_DeleteSuspendedTransaction

Delete the suspended transaction  

Public Method

X_EOD

X_s the eod.  

Public Method

X_GetDeltaQueue

XML based call to gets a Delta Integration Queue of a mobile device with its record details.  

Public Method

X_GetExchangeRate

X_s the get exchange rate.  

Public Method

X_GetGiftCertificateBalance

Get the gift certificate balance.  

Public Method

X_GetInventoryOfProduct

Get inventory of product for all warehouses.  

Public Method

X_GetMobileDatabase

 

Public Method

X_GetPointsSummary

Get Points Summary for Loyalty Id  

Public Method

X_GetTransaction

Gets a transaction data based on transaction Key  

Public Method

X_PostFulfillment

XML based call to sync the delivery data to server.  

Public Method

X_RegisterLoyaltyCustomer

XML based call to sync the Loyalty customer data to server.  

Public Method

X_SaveCustomer

XML based call to sync the customer data to server.  

Public Method

X_SaveTransaction

XML based call to sync the transaction data to server.  

Public Method

X_SearchTransaction

Gets a transaction data based on search query  

Public Method

X_SyncInventory

XML based call to sync the inventory.  

Public Method

X_UpdateLoyaltyCustomer

XML based call to sync the Loyalty customer data to server.  

Top

See Also

Reference

IntegrationService Class

CXS.Retail.API Namespace

Send Feedback