Getting started
You will need to contact Portbase to request API credentials, Portbase will charge a fee for this. Once you have received the API credentials, you can contact our support team to set up the integration for you.
We will need these API credentials (= Portbase-access-key-id and a Portbase-secret-access-key) before we can proceed with the next steps.
Operational/day to day use
Order detail
When you create a new order and you select a terminal then you will see the terminal container icon appear:
After you save the order, you will also see a booking object:
You will see that it is in the status to register, which means the statuses haven't been requested yet from Portbase.
Once you complete the "Sync container status with external system" task, then you will start receiving the status updates and you will see that the status goes from to Register to registered.
The statuses are the following:
Available: the container has arrived at the port
Customs cleared: the container has gone through customs clearance
Released: the container has been released
General status: this is the summary from all the statuses above
Icons:
Question mark: we didn't have any status information
Green: it is okay
Red: there is an issue
This will be similar to what you see in portbase.
Planning
In your to plan section, you need to click on customise:
And then activate the Container status column:
This will allow you to see the container status in your to plan screen.
We also have a special container terminal booking screen on your to plan:
When you click this button, you will see an overview of all your container terminal statuses:
Configuration done by customer
You need to link your terminal locations to the correct Portbase terminals. You can do this by going to the location detail via Locations tab.
Then you need to open the location and select the correct terminal:
If you can't find the terminal, then click on show all global locations to get the full list:
Don't forget to press save once you selected the correct location.
Configuration done by Qargo
Configuration: Tasks
You need to go to the task configuration:
You should see an additional section with "Container terminals" where you should see the following tasks:
Sync container status with external system: this will request the status to Portbase and display it in Qargo. Ideally this task is configured as Automatically complete.
Create container booking: this will collect the necessary information and create the container booking but it will not yet send it to portbase.
Send booking to terminal: this will send the booking to Portbase.
Configuration: Organisation settings
The feature flag for container bookings should be active:
If this is not the case, then please contact our customer support team to activate this for you.
Configuration: Integrations
Under configuration => Integration, you should see the Portbase:
If this is not present, then please contact our customer support team to activate this for you.