Tradera Developer Program

Tradera Developer Program

It's easy to get started coding for the Tradera API.

  • Go to the registration page to create a developer account.
  • Register an application to get the application keys needed to access the API.
The API provides six SOAP services but if you are integrating a shop you will likely only ever use the top three:
All methods are described in the WebService Reference and some methods have code examples in PHP included
Methods in RestrictedService are only available after activation for your application by Tradera. Also, there is a call limit on 100 calls/24 hours for all methods. If you exceed the rate limit, a response with HTTP response code 429 (Too many requests) will be sent. If you need access to RestricedService or more calls, please contact and explain what your application will do and why you need access to RestrictedService/more calls. Don't forget to state your application id. 

Please note that we do not support API calls for the payment method PayPal as of September 15th, 2020.

Getting Started 

These steps will allow you to quickly get started developing your application with the Tradera API. Some of the information is focused toward integrating an existing shop in order to sell items on the Tradera platform and most of the examples are written for PHP.

Prerequisites and setting up

In order to develop your application you need to register an account with the developer program. This is not the same as a Tradera user account. The developer account will be used to manage your applications.

When you have a developer account you can create your an application. On the application page you can view the following information:

  • AppId The ID of your application needed for all calls to the API.
  • Service key This is also used with all API calls to verify your AppId.
  • Public key Used with the token login see Authentication and authorization for more information.
  • Methods All methods and the following information about them: wether they are disabled, how many calls have been made and remain, and also a link to their documentation page.

Some methods are only available after activation for your application by Tradera. Also, there is a call limit on 100 calls/24 hours for all methods. If you exceed the rate limit, a response with HTTP response code 429 (Too many requests) will be sent. If you need access to other services or more calls, please contact and explain what your application will do and why you need access to those services/more calls. Don't forget to state you application id.

Tip: If doing larger operations (such as updating or adding a lot of inventory) it is best to schedule this to take place at night when there is little other activity since request will likely be processed more quickly.

Most methods (those in Public Service excepted) require a Tradera user account. These actions will be performed as by that user. Please see Authentication and authorization for more information about this.

There is a push function for the API as well. This is not activated by default and requires an Amazon Web Services (AWS) account. Push can be triggered by the creation of an order (when payment has been made through an integrated payment option) or when an item is closed (the end date for the item is reached or quantity reaches zero).
Note that at the time of writing these push notifications contain very little information (item ID if an item is closed or order ID and creation date if an order is made). See Push API for more information and a quick start guide.

If using PHP to communicate through the API the PHP Soap extension needs to be installed and available. You can check this with:

$ php -r 'echo extension_loaded("soap") ? "OK" : "Not OK"; echo PHP_EOL;'

Suggestion for integrating a shop

To enable you to get started even more quickly we have a suggestion for methods to use and way of interacting through the API when integrating a shop. With these methods you will be able to do the things necessary for selling your shop's items on Tradera.

Suggested methods

All of these methods come with code examples and type documentation. The methods we suggest using are:

Getting your token

The method FetchToken can be used to get a token for a user after the user successfully has logged in using the token login (see Authentication and authorization). The token is needed for most methods since they need a Tradera user. The expiration date of the token is also returned with the request and you should pay attention to this.

Getting values to use with certain attributes.

Some attributes need integer values that correspond to, for example, payment types. These can be retrieved with the method GetItemFieldValues. There is a code example in the method documentation that can be used almost right away.

Adding an item

Adding shop items can only be done with the AddShopItem method but there are several ways of editing items. When using this method the request is placed in queue and processed as soon as possible, it can be almost instantaneous but also take quite some time depending on the current server load. The GetRequestResults method can be used to see if the request has been succesfully completed.

Removing items

For removing items (so they do not show up in searches) the method RemoveShopItem can be used. Shop items with a quantity of zero are not displayed either so it is possible to prevent items from being searchable or bought by setting their quantity to zero. This can be done in bulk and differs from RemoveShopItem in that it does not return a QueuedRequestResponse that has to be checked to ensure the request was successful.

Changing items

Changing items can be done in different ways. When only changing the quantity the easiest way is to use the SetQuantityOnShopItems method. It can change a number of items at a time, the quantities are set individually, and it does not require extra checking of the result. It returns wether it was succesful when called instead of creating requests. The method SetPriceOnShopItems is very similar to its quantity counterpart but it returns a request id that must be used to check the request was successful. Whenever anything other than price or quantity needs to be changed UpdateShopItem must be used. It is somewhat similar to AddShopItem except any attributes that should not be changed can be omitted or set to null. Only one item per request can be updated and the result of the request needs to be checked with GetRequestResults.

GetSellerItems can be used to view items. Although it never returns items that have a future start date

Receiving orders

Orders can be retrieved using the method GetSellerOrders. We suggest using the LastUpdatedDate option to narrow the search to only include orders that have been updated since you last polled for orders. This is because an order is updated when it is paid. This only works with Traderas integrated payment options however. If you only fetch orders that have been updated since your last poll and filter away those without payment information (see code example in the methods documentation) you will only receive each order once.

Orders can be marked as shipped using the SetSellerOrderAsShipped method.