Query the data in Volusion e-commerce with TaskCentre

This article is taken from the Orbis Software knowledgebase:

How to query the data in Volusion e-commerce with the TaskCentre Web Service Connector tool?

Summary:

The Volusion e-commerce system contains product, orders and customer data. If you need to extract some of that data perhaps for integration into another system or for some business process automation or alerting activity then the TaskCentre Web Service Connector can be used. Before it can be used in a task the global connection to your instance of Volusion must be established and the structure of queries that you wish to make defined. This article provides information to help you set these up. Part one shows how to derive a generic XML query string though the Volusion product API. Part two shows how to configure the TaskCentre connector, make use of the XML query string and paramerterize the query for task automation.   

Instructions - Part One

1.     The Volusion website provides help for building queries. Login to the administrator area (when you first sign up for an account you will be given the url to your administrator area) and select Inventory and Import/Export

Select Inventory and Import / Export

2.     Then select the Volusion API button.

3.     Then select one of the options from the Generic API, Orders, Products or Customers. Click Run.

 Choose the API

4.     Select Columns that you wish to return from your query by checking the relevant boxes. Enter data in the ‘Where Value’ column for any parameters that you wish to present to the user when configuring the task, e.g. you may wish to query orders by status, perhaps finding all orders with a status of New. In this case you enter ‘New’ in the where value column for the status. When you set this up you should choose values that are likely to return data. These values can be altered later at task configuration time. 

 Select the columns to include in the query

5.     Then click Run at the top.

If you wait a moment it will generate a URL. Something like this:

http:///net/WebService.aspx?Login=&EncryptedPassword==&EDI_Name=GenericOrders&SELECT_Columns=o.OrderID,o.AccountNumber,o.BillingAddress1,o.BillingAddress2,o.Order_Comments,o.OrderStatus&WHERE_Column=o.OrderStatus&WHERE_Value=NewInstructions

Part Two

1.     If you now go into TaskCentre, and open the global configuration for the web service tool. Click on add to add a new service and give the service a name e.g. Volusion and select the last option as below.

New configuration dialog

2.     Copy the beginning of the URL from the generated URL above, up to the ‘?’ (Question mark). Don’t bother with interrogating the service, it will not be successful. Then go to the operations tab.

 Web Service Root Tab

3.     Click Add on the right hand side to add an operation.

4.     Choose a name for the operation and select the GET operation.

  New HTTP Operation dialog

5.     Then go to the URL tab.

6.     Select the checkbox ‘Use the connection URL’ at the top. 

 Select use connection URL

7.     Then take the remainder of the URL that you generated and paste it in the edit box at the bottom

 Paste the rest of the URL

8.     Now you can make the query parameterised so that the user can choose the status

 Enter the parameters

Enter a parameter name that you want to appear for the user to pass data into at task configuration time.

9. Now drag the parameter you have created down into the URL, replacing the value that you entered into query originally, ‘New’ in this case.

           Replace NEW

10. Now we need to define the output from the operation, and we do this on the Output Data tab. We first need to check the Output required checkbox at the top. 

 Select Output Required

11. Then click the Send test message button. 

12. Enter a parameter value and press test. A results message will be returned. You don’t need to be concerned with the details of this, if it looks like a set of data from a query then all is well.

 Test the operation

13. The results message will be returned to this dialog. If you click on the Infer schema from XML or JSON button this message will be transformed into a schema defining the format of the returned data.

 Infer the schema

14. You then need to click on the validate schema button.

15. If you now click OK you have successfully created an operation that queries Volusion and this will now be available to the Task Designer to include in task steps.

To learn more about using TaskCentre with Volusion or any other ecommerce solution click here or telephone (877) 241-7713.

 

 

comments
0