Frequently Asked Questions

We would like to refer to the FAQ page on our website www.transfollow.org for non-technical questions.

General

Where can I test TransFollow development?

We have a full operational partner environment available to test an implementation against a working backend. Check also our developer tools and apps that are provided to test a complete TransFollow lifecycle.

Authorization

What is the relationship between the OAUTH client id and client secret (API key) and TransFollow user credentials?

The authorization for TransFollow is based upon a combination between client authentication and user authentication. A user is able to login with a TransFollow account using a client that is authorized to communicate with the TransFollow API. TransFollow B.V. is responsible for client authentication and will distribute and maintain API keys for each client that can communicatie with the TransFollow API. In case of improper or misabuse of TransFollow, we will disconnect the API key on client level. Therefore it is recommended for software suppliers who offer customer specific configurations for their product to configure customer specific OAUTH authentication.

TransFollow accounts are created and maintained by users only via the webportal or mobile apps. TransFollow B.V. has no access to account information or have the ability to change this information.

A detailed desciption is available in our Get Authorized section.

FreightDocuments

Wat is the difference between the fields freightDocumentId and authorityReference?

We distinguish authorityReference as reference used for human communication about a waybill, and freightDocumentId as the unique identifier for clients communicating with the API. It is therefore recommended to communicate the freightDocumentId in existing electronic data exchanges between related clients in the supply chain.

A freight document can be changed as long as it has the status draft. It is recommended to perform a GET /freightdocuments/{freightDocumentId} in order to retreive a full body of the existing freight document. Then the entity submitterAccountId should be made empty in the request body of the call PUT /freightdocuments/{freightDocumentId}, which also includes all changes that are necessary. See the API Endpoint Specifications for an example and mandatory fields.

How to create a freight document for demo's.

Make sure you have setup (different) TransFollow accounts for the Consignor, the Consignee and the Carrier Roles that you will use for the freight document. TransFollow Accounts can be created at https://portal.partner.transfollow.com, the TransFollow Partner Portal. These accounts are only valid for the partner environment. If you prefer you can create a separate account for submitting the freight documents. Log in to the partner portal with the account you’d like to use as submitter and apply for sufficient credits. Granting the credits might take a little while, so please plan in advance.

You can use the TF Android app to create freight documents. Log in with the Carrier account that you plan to use in the freight document. You may also first log in with the submitter to create the freight document, and then after creating the freight document log out and log in with the carrier. Creating an freight document in the TF Android app starts by touching the blue + button in the bottom right-hand corner of the freight document overview screen. You will be warned if you have no credits. A wizard will help you fill in all the mandatory fields of the e-CRM form. There is also no edit mode. Once you have created an freight document it is immutable and ready for processing. In TransFollow terms it has become ISSUED.

The TF Android app also lets you process an freight document that you created but only if you are logged in with the same account as the Carrier role on the freight document. If not, you will not be able to initiate the signing process. The portal also shows all freight documents that you have created or have any other role in.