- Who is this for?
- Operations managers, transport operators, IT teams and TMS owners
- Question addressed
- Assess and scope the operational transfer of orders between shipper portals and the TMS.
Key takeaways
- A portal is covered only when a specific flow has been qualified and tested, not when its name has been added to a compatibility list.
- Orders, amendments, statuses and documents must be mapped separately because they may not follow the same route.
- APIs, file exchange and user-interface interaction are complementary access methods selected according to the action and required control.
- An external identifier must be linked to the TMS identifier before any creation or update to limit duplicates and status discrepancies.
- An expired session, changed screen or uncertain result must stop the workflow and trigger controlled recovery.
Start with the flow, not the portal name
Two portals may expose different functions, and one portal may be used to receive an order, download a document, confirm a slot or report a status. Saying that a portal is “connected” therefore says nothing about what is read, what may be written or how the result is checked.
Useful scoping takes place at object and action level. For every flow, the team identifies the system of record, triggering event, available references, granted permissions and expected state in the TMS. This map separates what can be processed from what should remain in observation or be returned to operations.
- new orders and corrected versions;
- amendments, cancellations and confirmations;
- slots, constraints and operational statuses;
- documents to download or attach;
- acknowledgements, references and evidence of acceptance.
The matrix to complete for every portal and object
The following matrix is a fictional scoping example. Each row represents a distinct flow to be verified with the portal operator and the team responsible for the TMS; it does not describe integrations that have already been deployed.
A row is useful only when its terms can be tested. “Access the portal” is too vague; “read a new order, find its reference in the TMS and check the five defined fields” creates an observable scope. The matrix should also name the owner of the control and the response when an identifier is missing.
| Source | Object | Identifier | Access method | Authorised action | Control |
|---|---|---|---|---|---|
| Fictional example — portal A | New order | Shipper reference + version | Documented API | Read the order, then prepare TMS creation | Search for the external reference in the TMS and reread the key fields |
| Fictional example — portal A | Slot amendment | Shipper reference + TMS identifier | API and notification | Prepare or apply the amendment under the validated rule | Compare the old slot, new slot and state actually recorded |
| Fictional example — portal B | Order batch | Row reference + file identifier | File deposited in an authorised location | Import valid rows only | Reconcile the import report, rejected rows and created orders |
| Fictional example — portal C | Order and attachment | Portal reference + document fingerprint | Authorised user-interface interaction | Download the document and prepare entry | Reopen the target record, verify its reference and confirm the document is present |
| Fictional example — portal C | Confirmation status | Portal reference + timestamp | File export or authorised screen | Read the status without changing it | Compare the observed status with the last known version and flag any discrepancy |
Combine APIs, files and the interface around the actual need
An API is useful when it exposes the required object, action and response with suitable permissions. A file works well for structured batches and deferred processing if versions, rejections and acknowledgements are controlled. Authorised interaction with the user interface can cover a function available only on screen, provided the journey, session and verification have been qualified. None of these access methods is automatically superior for every flow.
One workflow may combine them: a notification announces a new order, an API provides the data, a file carries the documents and the interface exposes a status that is unavailable elsewhere. The architecture should follow the source of truth and the level of risk instead of forcing every event through one channel.
- 01Read
Select the access method that supplies the useful data with its reference and version.
- 02Decide
Apply only the rules and permissions validated for this object.
- 03Act
Create or update the TMS through the method defined for that action.
- 04Verify
Reread the authoritative state and retain evidence of the outcome.
- 05Hand over
Return ambiguous, prohibited or unverifiable cases with their context.
Prevent duplicates and status discrepancies
The main risk is not limited to an incorrect field. The same order may appear in an export and later in the interface, be sent again in a second batch or be amended after it was first read. Without a matching key and version history, recovery can create two TMS orders or overwrite newer information.
Before creating anything, the workflow searches the TMS for the external identifier and any authorised secondary keys. Before an update, it compares the source version with the last processed version and current state. A similar route, date or customer may help propose a match, but it is not enough to merge two transports silently.
| Observed situation | Safe decision | Expected control |
|---|---|---|
| Same identifier and same version already processed | Do not recreate; classify the event as already handled | Find the TMS order and verify the critical fields |
| Same identifier, newer version | Compare changes and apply the amendment rule | Retain before-and-after values and reread the new state |
| Missing identifier but a similar record exists | Pause creation or propose candidate records | Validate the match before any sensitive write |
| Portal and TMS statuses conflict | Apply the precedence rule when one exists; otherwise hand over | Present both sources, their timestamps and the latest verified action |
Plan for sessions, changes and recovery before deployment
Portal access changes over time: an expired session, stronger authentication, a revoked permission, a renamed label, a reorganised screen or a changed file format. These events must not be treated as an absent order or bypassed. The workflow stops when it no longer recognises the validated conditions or cannot prove the outcome.
Recovery begins by establishing whether an action has already occurred. The workflow rereads the portal and TMS using known identifiers, then classifies the case: no action observed, successful action, partial result or indeterminate state. Only the first case allows an automatic retry when the rule permits it. The others require controlled correction or a human decision to avoid creating a duplicate.
Within a qualified scope, Vigilo can connect a portal event to the transport record, apply authorised rules, prepare or execute the planned action and check its outcome. Deployment remains specific to the company’s sources, objects, identifiers, access methods and responsibilities; it is not a promise of instant compatibility with any particular portal or TMS.
- test normal session expiry and renewal without bypassing protections;
- detect a screen, field, format or permission that no longer matches the validated version;
- retain the last confirmed checkpoint and all identifiers already obtained;
- reread both systems before any new attempt;
- version the map and suspend only the affected flow;
- give the team the source, attempted action, observed state and required decision.
Frequently asked questions
Direct answers
Is an API required to automate a shipper portal?
No. An API, file exchange or authorised interaction with the interface may be appropriate depending on the available function, permissions, volume and required control. A single workflow may combine several methods.
How can a team avoid creating the same order twice in the TMS?
Retain the portal identifier and version, search for that identifier before creation, then reread the TMS after the action. If the identifier is missing or several records match, validate the link before writing.
What happens when the session expires or the portal changes?
The workflow should stop, report the unexpected condition and establish whether an action has already occurred before recovery. The affected map or journey is then tested and versioned before it is reactivated.
Sources and methodology
This resource describes Axonovia's product approach based on transport workflows. The examples are illustrative and do not constitute a performance commitment or a universally applicable contractual rule.
Product review: Axonovia team · next review recommended before 31 August 2027 or following a material change in scope.