Using eBay web services with the Web Service Connector Tool

Introduction

The TaskCentre Server can be used to automate calls to the eBay Trading API.

Four operations are made available, which provide the key functionality of downloading products, downloading orders, uploading inventory status changes and uploading order status changes. This article deals with the idiosyncrasies of this web service that you will need to understand in order to use it successfully.

If you are familiar with the eBay Trading API, you may wish to note that the operations available make use of the raw calls GetSellerList, GetOrders, ReviseInventoryStatus and CompleteSale. An additional operation, GeteBayDetails, is provided in its raw form for the purpose of retrieving certain metadata, such as the available shipping carriers.

Initial setup

This article assumes that you have already installed the Web Service Connector Tool (service release 4 or higher). Firstly, you need to download our eBay Trading API connection file, which tells the Web Service Connector Tool how to communicate with eBay’s web services.

Note: This web service file is currently not available.

The file must be imported into the Web Service Connector Tool by opening the tool’s global configuration window and clicking on the Import button and locating the TCWX file.

Subsequently, you will be prompted to give a descriptive name to the web service configuration (e.g. “eBay Trading API”) and to provide the values of two important parameters, the eBay user token and the eBay site ID.

The two sections below describe how you can acquire these values.

Import parameters

Determining your site ID

A site ID is what the eBay web service uses to determine which of the numerous global eBay websites you are dealing with. Site ID 3, which signifies the eBay United Kingdom website, is specified by default. A list of all of the possible site IDs is available at http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/types/SiteCodeType.html.

Acquiring a user token

A user token identifies you to the eBay web service. It signifies your consent for the TaskCentre Server to carry out operations on your behalf. User tokens are generated in the eBay Developers Program. If you don’t have a developers program account, you will need to create one first.

Create an application, then generate a set of Production keys (you do not need to make a note of these).

Create an Auth’n’Auth user token for the Production keyset. You will need to enter the username and password of your eBay account (not the account used for the developers program). Save the token for importing into the Web Service Connector Tool.

Screenshots illustrating this process can be found at: Using eBay web services with the Web Service Connector Tool (user token screenshots).

Sandbox environment

If you wish to test your eBay tasks before deployment, you may wish to direct your web service calls towards eBay’s Sandbox testing environment instead of the live eBay site.

Using the eBay Sandbox website

The eBay Sandbox website is located at http://www.sandbox.ebay.com/ and is a copy of the real eBay site, using pretend money instead of real money and pretend products instead of real products. You can list items for sale on the Sandbox site, buy them using the pretend money, and then use the TaskCentre Server to make test web service calls to retrieve information about your pretend products and orders.

Making calls to the eBay Sandbox web service

To direct your calls towards the Sandbox web service, you should open the global configuration of the Web Service Connector Tool, locate the eBay Trading API connection file, open it with the Edit button, navigate to the “Web service root” tab, and then replace the URL with the following: https://api.sandbox.ebay.com/ws/api.dll.

To reverse this change and revert to making calls to the live eBay web service, repeat these steps and change the URL back to the following: https://api.ebay.com/ws/api.dll.

Root URL

Article originally published 03 December 2015 — Article updated 04 July 2017
eBay Integration Brochure

eBay Integration Brochure

Learn how integrating eBay with your other business applications can save your organisation time and money and improve performance.

Download Brochure