Getting Started

Tradeshift is a global business network that allows anyone to exchange invoices for free, but it won't be just invoices any more! With the Tradeshift Apps framework, you are now able to extend our services with any feature you can think of for a business-to-business network. You can even make money in the process by selling your app to users in the Tradeshift App marketplace. Harness the power of a global business network! With knowledge of Javascript, CSS, HTML and with a good idea you can change the way people do business around the world!

Creating apps in Tradeshift means (in most cases) extending the existing user interface you see in the web application. This is why we also call Tradeshift apps embedded apps. So, the code you make will usually create new UI elements: boxes, buttons, inputs, text, etc. Apps can be embedded in two ways, either as iframes or directly injected into the existing markup, which is what we will call inline apps. An example of how to create an inline app is described below.

First step

Before you get started you should get in touch with us to share your plans and get the necessary details and directions.

Contact us

What is a Tradeshift App?

A Tradeshift app is any extension of Tradeshift’s functionality that can be obtained, activated and managed through Tradeshift Apps [WHERE it's created]. The latter: “Tradeshift Apps” is the name of the “store”, where users find, pay for and activate apps. All apps available in Tradeshift's directory have been reviewed and approved by Tradeshift.

Apps exist in the following variations:

  • Embedded app: An app that appears in the Tradeshift web application and functions as a natural extension of the existing web interface. Embedded apps can be inline (html, javascript, css and images) or iframes (using webpages from other domains).
  • Integration app: An app that makes Tradeshift functionality available to other applications outside of Tradeshift’s web interface. E.g. an integration to a SaaS accounting system or an Android mobile app which typically utilizes the Tradeshift API.

Availability of any of the apps can be controlled in a variety of ways:

  • Exclusive app (not implemented yet): An app that is only available to a subset of Tradeshift’s user base. This can for instance be based on language, company location and connection to another company in Tradeshift. These availability settings are handled in the app manifest through the developer app.
  • Approved app: An app that has passed Tradeshift’s approval process and is available in the upcoming Tradeshift Apps.
  • Non-approved app: When an app is non-approved it is not made available through Tradeshift Apps. Before being available in Tradeshift Apps an app has to be reviewed and approved by Tradeshift. Any app under development is non-approved, but the developer can at any time copy the source code and send it to other developers who can then activate and test the app through the developer app.

What elements does an app consist of?

App menu item [expected behavior upon release]

All apps are by default placed in the apps menu in Tradeshift. This is a 1st level menu item. Users having multiple apps activated will have a drop-down list containing a menu item for each app currently activated. The menu item links to the app page which is mandatory for all apps. The name of the menu item is the app name and cannot be changed from that.

App page [expected behavior upon release]

All apps are accessible through the apps menu. The app menu item links to the app page. All apps will by default have an app page which cannot be disabled as this is the one consistent location, where users can find activated apps. The header of the app page is controlled by Tradeshift and displays the app name and icon along with functionality to find the app in Tradeshift Apps, link to deactivate, recommend and rate the app, as well as showing vendor information.

The app page can be used for app settings and if a full page view of any functionality is needed.

App component

Embedded UI elements controlled by app purpose and behavior. These are the building blocks of embedded apps and exist in two "flavors": iframe components and inline components.

Iframe components embed an iframe in the UI. For iframe components the default app stylesheet should be used.

Inline components embed your app markup directly into the Tradeshift markup.