VMCONNECTOR Web services functions description

This Virtuemart addin module is quite different than most of Joomla modules available, it allows you to reach your Virtuemart online shop as a remote server directly from your own applications and databases.

VMConnector module is a Virtuemart client / server enabler to ease Virtuemart integration into your day to day operations and processes.

You can group VMConnector web services functions into two groups:

1. VMConnector UPDATE web services functions:
   
   
• Function: SendCategories - VM Catalog categories update - Mass update / Multiple operation types at once (Update, Add, Delete)
  
  
  • Main VM Category fields management (SendCategories: parameters):
    
    
    • Parent and child categories hierarchy maintenance
    • Category Image
    • HTML or text category description
    • Category published or not
    • Category Name
    • List_order
    • Currentpos
    • Category browse page (how products are displayed within on category)
    • Products_per_row (Show x products per row)
    • Flypage (Product's details page)
      
      
• Function: SendProducts - VM Catalog products update - Mass update / Multiple operation types at once (Update, Add, Delete)
  
  
  • Main VM product fields management (SendProducts: parameters):
    
    
    • Parent categories (change all multiple categories products belongs to)
    • Related_products (Shows at the bottom of the page related products)
    • Product parent_id for child product updates (manage all the child products)
    • Sku (Unique product identifier)
    • Product name
    • Published or not
    • Product linked URL
    • Price (change all prices at once using MS Excel formulas)
    • Shopper group price management
      
    • Currency
    • Tax_id (VAT, TVA, IVA, ...)
    • Discount_id
    • Discounted_price_override
    • Short product description
    • HTML or text product description
    • Current stock difference (maintain your stock levels)
    • Available_date image
    • Product availability date
    • Product images (large and thumb)
    • If it's on special (put on special groups of products at once)
    • Advanced attribute (manage your products attributes)
    • Custom attribute
    • Product item attributes update, for stock management
    • Shipping length / width / height / lwh_uom / weight / weight_uom / unit / packaging / box / downloadable / downloadfile
    • Product's types and parameters can be automatically added to products or updated (as long as the product type and its parameters have been defined from within the Virtuemart administration screen).
      
      
• Function: SendUPD_Orders - VirtueMart sale order update status / comment - (SendUPD_Orders: parameters)
  
  
  • This function allows you to update Virtuemart sale order status and related comments when processed for example within your local accounting system.
    
    
    
2. VMConnector QUERY web services functions:

• Function: GetCategories - VM Catalog categories query - (GetCategories: parameters)
  
  
  • This functions allows you to query one / all / several VM catalog categories at once.
    
    
• Function: GetProducts - VM Catalog products query - (GetProducts: parameters)
  
  
  • This functions allows you to query one / all / several VM catalog products at once.
    
    
• Function: GetOrdersHistories - VM Orders history query - (GetOrdersHistories: parameters)
  
  
  • Gets all history changes for one order ID.
    
    
• Function: GetPayMethods - VM Customer's payment type query - (GetPayMethods: parameters)
  
  
  • Gets customer's payment method for a specific sale order (based on order_ID number)
    
    
• Function: GetCustInfo - VM Customer's infos query - (GetCustInfo: parameters)
  
  
  • Gets Customers details based on User_id and order_ID number contained in sale order information.
    
    
• Function: GetOrders - VM Sale Orders infos query - (GetOrders: parameters)
  
  
  • Gets one sale order by its order ID number or all orders if ID number equal 0 (zero).
  • If order ID equal zero, sale order status and date criteria are available.
    
    
• Function: GetProdOrders - VM Product sale order infos query - (GetProdOrders: parameters)
  
  
  • Get Products Ordered based on a sale order ID
    
    
• Function: GetCountries - VM Country sale orders query- (GetCountries: parameters)
  
  
  • Gets sale order country information
    
    
• Function: GetProdIds - VM Products'ID query based on category ID- (GetProdIds: parameters)
  
  
  • Gets VM Catalog Products ID based on Category ID - Parameters can be a single ID or many 1|2|3| ...
  • This functions allows to query for example all products for one category or different selected categories.
    
    
• Function: GetProductTypes - VM Products'ID query based on category ID- (GetProdIds: parameters)
  
  
  • Gets all VM Product's types and parameters.
  • This function allows to query all product's types and parameter details to validate the SendProducts which can contain now product's types and related parameter information (DocLink ).

 

As all SOAP web services, you can use programming software like MS .NET (VB, C#,...), PHP, Delphi, VBA, C++, ... to consume easily these web services and connect your current products catalog database to VirtueMart component.

The web services files uses the standard WSDL (Web Services Definition Language) to define their interface. For domain name = "www.idtsa.com", the corresponding WSDL files would look like this:

Only one administrator should work at a time to maintain their VirtueMart eCommerce catalog.

Each called web service requires a valid admin joomla user id and password parameter.