Before you start

Requirements – Technical skills

Technically speaking, SHIPTIFY APIs are a set of Operations accessible by a standardized web protocol. Each operation can be called by a client application to request shipment information or even book a shipment. Client applications will request a certain operation to be executed with the application specific request data. SHIPTIFY API then responds synchronously by sending back response data in a standard pre-defined format. The client application can then process the response data to complete the subsequent workflow.

In order to access the web service RESTful Services are used and developers should be familiar with JSON and have a basic understanding of web services.

Requirements – Business understanding

Developers who plan to connect their tools or services to SHIPTIFY APIs should also have a closer look into SHIPTIFY’s products and services. More details about our products and services are available at www.shiptify.com and your SHIPTIFY Sales representative.

Requirements – API Key

Before you start using our REST API services, you will need to obtain your API key with your SHIPTIFY sales representative. Api-key is persistant and has no time limit.

Access conditions

Shiptify reserves the right to terminate services if we detect any abuse on API Key. Shiptify reserves the right to modify services design and specifications.

Limit

Be nice. If you’re sending too many requests too quickly, we’ll send back an error code (TooManyRequests). You are limited to 10 reqs / sec per account.

If you want to plan performance tests, please be in touch with our team before at [e-mail].

What can I do with API?

The Shiptify Platform was created to bring together all stakeholders of the supply chain in one intuitive UI.

The Shiptify API is designed:

• to allow input of external generated data inside Shiptify Platform.

• but also to retrieve generated data from Shiptify Platform.

All actions related to interactions between people are exclusively set through our UI (Shipitfy Platform) and not via the API. Therefore, all actions linked to internal workflows are not possible (Per instance: change status of a shipment).