Transport Order Ingestion Channel guideline - Integrated Seller

Introduction

Below you will find the steps a Seller should take to setup an ingestion channel with Eclic to upload transport order information using the NxtPort ingestion channel. In this document we assume that the seller is already pre-registered on NxtPort and is subscribed to the eECD application via a valid eECD admin account.

The process of setting up a transport order ingestion channel is divided into 4 steps:

1. Initiating the process

2. Setting up an ingestion channel in Staging environment

3. Testing the ingestion channel

4. Setting up an ingestion channel in Production environment

Initiating the process

The Seller contacts ECLIC (info@eclic.eu) to initiate a change request and to formally request to become an “integrated seller”. An “on-boarding” meeting is set up with NxtPort and any other required stakeholders to discuss the following:

1. The minimum required eECD data fields (XML message) are reviewed and the change request describes in more detail how the transport orders ingestion channel will be fed with new transport order data (via message broker, direct via SAP,…), (XML structure below).
   Note: In case a message broker is involved, the “on-boarding” meeting is extended with the message broker like Transporeon/Elemica contact.

2. The timeline of the change request and estimated set up cost are reviewed with the Seller (not with the broker).

3. The set up of an ingestion channel requires the seller to register with an eECD test account in the test/staging system.

Setting up an ingestion channel (in STG)

To obtain the ingestion channel authorization keys, you need to create a support ticket and provide the information below:

• Your company name

• The VAT number of your company

• Mention you want to setup an ingestion channel for the eECD application

• Mention the environment you want to start the integration for (in this case Staging)

NxtPort support will provide you with a client_id & secret and the ingestion channel url (by e-mail) for the correct environment. The keys will be different between Staging and Production environment.

With the above information you can fetch NxtPort access tokens as follows:

• Send a POST request to https://login-stg.nxtport.eu/connect/token with the following body (*not* parameter or header) keys:

  • username: email address of a user of the Seller

  • password: password of a user of the Seller

  • grant_type: password (hard coded)

  • client_id: Client ID provided by NxtPort

  • client_secret: code to verify the client_id, also provided by NxtPort

  • scope: nallian-eecdapi offline_access (hard coded)

Note that the access token will only be valid for 1 hour and has to be refreshed to allow for the data ingestion to continue. This relates to the strict security policies that NxtPort needs to adhere to.

When using a data broker

A data broker who, on behalf of the Eclic member, will setup the ingestion channel will have to be provided with the same information to be able to request an access token. It is advised however to create a separate NxtPort username and password for the data broker in the sellers NxtPort environment to request the access token. This to ensure that the data broker does not have access / rights to other use cases the seller is involved in on the NxtPort platform. Note that the user created for the broker does not need any use case / console roles. Please see below:

Testing the ingestion channel

To effectively test the ingestion channel, it is best that all parties involved are aware when the testing will take place. The Seller (or data broker) will need to inform NxtPort when testing is planned to take place. Before testing can take place, the following steps need to be taken:

1. Data message structure: NxtPort will provide information to the seller or data broker on the data structure of the XML order as soon as a formal change request is approved.

2. Create a support ticket and provide NxtPort a list of all DUNS numbers as carrier identifier in an excel file that includes the following columns:

   1. Carrier Name

   2. DUNS Number; or

   3. VAT Number

The following link informs you which Carriers have already been setup for the ingestion channel.

The Seller needs to setup its product master data and integrated loading location table. In case master data is missing, a transport order error message will be generated.

To send the xml order, do a POST call to your channel (URL as received in step 2) and add the access token in the header of the call, here is an example:

A transport order (original, change or cancellation) is sent successfully when it is visible within the eECD application (under menu “Transport Orders”). In case you do not have access to this menu, please contact info@eclic.eu to ensure the Seller is setup as “integrated seller”.

Once the tests have been successful in Staging, process steps 2 and 3 can be followed in Production. In process step 2, The URL which you will be using to fetch the NxtPort access token is: https://login.nxtport.eu/connect/token.