Carriers

3M has identified you as a possible carrier to collaborate with?

Connecting to Viya for 3M will contain the following:

  1. Despatch-advice communication:
  • For direct Road consignments the information for the load can be shared with you through Viya.
  • Air/Ocean, reconstruction and express flow through M3, use your M3 contact.
  • Labelling of the handlingUnits is done by warehouse, so no label is produced by Viya.
  1. Tracking communication
  • For any consignment shipped, tracking information is expected.
  • All tracking events can flow through Viya, with the exception of Air and Ocean which goes directly to 3M SAP.

Test vs Production:

  • Viya has a test environment available for testing the integration. We recommend creating a test environment and keeping that available for future changes.

Implementation process

From the moment you (the carrier) are identified to be added to the portfolio, up to the first live shipments:
below are the typical steps we take you through during implementation:

  1. Kick-off call: introduce each other, share intentions & capabilities on scope and timeline.
  2. Per message type (Despatch-advice and/or Tracking):
    1. Agree on format: see the integrations below for options of the format to exchange.
    2. Provide specifications & samples: A session is typically planned between Viya and Carrier to verify any questions on the specifications. It depends on carrier capabilities if a carrier standard or Viya/3M standard is used.
    3. Develop: One party develops the integration, the other party likely configures it.
    4. Agree on communication method: See the integrations below for available communication methods. Note that each integration can have a different communication method.
    5. Handshake with chosen communication method: Short step to validate that the ‘pipeline’ between Viya and the Carrier is working. E.g., place a file on SFTP or do an HTTP call to a REST endpoint.
    6. Integration test: Carrier and Viya go through basic tests to confirm the connection, and basic scenarios, are working.
  3. End-to-End test: 3M will send transactions from their SAP Test system to verify the test process works, various scenarios can be run here. Communication between Carrier and 3M.
  4. Soft go-live: First go-live with a limited set of consignments to verify all production configurations are ok.
  5. Go-live: All shipments start as per SOP.

Despatch advice

This message is transmitted for consignments that are loaded at the shipper’s location. It confirms the load details and includes the reference number to provide tracking information against.

Depending on the integration capabilities the following payloads are available:

  • GS1 Transport Instruction (GS1-TI)
    • This is the most comprehensive format, it contains all information including dangerous goods details, reference information, shipments inside the consignment.
    • When also integrating with M3, this is typically the format used.
      • Keep in mind that there are minor differences between the M3 and Viya implementation of GS1-TI, mostly where Viya will send out 1 consignment per GS1-TI, M3 can send out 1 GS1-TI with multiple consignments.
    • Implementation details can be found here: gs1-ti
    • Communication method: SFTP
  • GS1 Transport capacity booking (GS1-TCB)
    • High level format that contains the load summary, references on consignment level. In essance it indicates: bring x cubic meters of goods from location a to b in this timeline.
    • See for details gs1-tcb
    • Communication method: SFTP
  • IFTMIN
  • Email
    • Receive an email with the despatch advice information.
    • See for details: despatch advice email
    • Communication method: Email
  • Custom: If you would like to use your own format or prefer an API integration, please contact us to discuss the options.

Communication methods

  • SFTP: Viya will place the despatch advice file on an SFTP server hosted by the carrier.

Tracking

To update the shipper’s teams and their customers on the status of the consignments, tracking information is to be provided. The tracking information can be shared in the following formats, in order of preference:

  • API webhook or HTTP POST to Viya, see tracking webhook
    • This is the preferred method, as it allows for real-time updates and is easy to implement.
    • Alternatively you can suggest a payload in JSON or XML format which Viya can consume.
  • API/Webservice where Viya pulls the tracking information from the carrier’s system
    • This is a good alternative if the carrier prefers to expose an API for Viya to pull the tracking information.
    • The carrier is in the lead to provide the API documentation and access to Viya.
  • GS1 Transport Status (GS1-TS), see gs1-ts
    • Communication method: SFTP
  • IFTSTA, see iftsta
    • Currently all the status information is taken from the STS loop (segment group 5). The following records hold the information needed:
      • STS (status code and/or description)
      • RFF (tracking reference)
      • DTM (event datetime)
    • Communication method: SFTP
  • Manual on Viya portal
    • In combination with the Email despatch advice, the carrier can manually enter the tracking information on the Viya portal.
    • This is useful for very small volumes or for carriers that do not have an automated system.
    • See for details: despatch advice email
  • Custom: If you would like to use your own format (CSV, xml, ..), please contact us to discuss the options.

Event data

The minimal data required for every event:

  • Date/time of event with timezone
  • Event code (status code)
  • Link to the consignment (tracking reference)

To improve the user experience it is recommended to also provide:

  • Location of the event (country, postal code, city, if available: coordinates)
  • Description of the event (status description)
  • Image of the event (eg. proof of delivery, damage, etc.)

Communication methods

  • SFTP: Carrier will place the tracking file on an SFTP server hosted by Viya. Viya will invite the carrier to connect to the SFTP server.

Tracking events

The following events are requested to be sent to 3M besides the Pickup & Delivery events. The events with a “mandatory” label are the minimum required events to be sent to 3M.

Viya event code3M Descriptionmandatorycomments
PickupRequestedCustomerPickupIncompleteCUSTOMER WILL PICK UP GOODS HIMSELF - MISSING
PickupRequestedCustomerPickupCUSTOMER WILL PICK UP GOODS HIMSELFY
PickupRequestedCustomerPickupDamagedCUSTOMER WILL PICK UP GOODS HIMSELF - DAMAGE
PickupCompletedPICKED UP SHIPMENT
PickupCompletedDamagedPICKED UP SHIPMENT - DAMAGED
PickupCompletedIncompletePICKED UP SHIPMENT - MISSINGY
BookingRequestedBOOKING CREATED
DeliveryAppointmentPlannedCUSTOMER AGREED ON APPOINTMENT DATE
DeliveryPlannedArrivalNoticeProvidedARRIVAL NOTICE TO THE CONSIGNEEY
CustomsDelayedIncorrectOrMissingInformationCUSTOMS - DOCUMENT INCOMPLETE/INCORRECT
CustomsInProgressCUSTOMS CHECK
CustomsReleasedCUSTOMS CLEARED
ExceptionDamagedDestroyedDAMAGED - DESTROYED
DeliveryCompletedPartlyDamagedSHIPMENT DAMAGED - PARTIALLY DELIVEREDY
ExceptionDamagedUnderInvestigationSHIPMENT DAMAGED - UNDER INVESTIGATIONY
ExceptionDamagedRequiresInputShipperSHIPMENT DAMAGED - UNDER INVESTIGATION (SHIPPER)
ExceptionDamagedUnderInvestigationSHIPMENT DAMAGED - UNDER INVESTIGATION (CARRIER)
DeliveryInProgressArrivedARRIVAL AT CONSIGNEEY
DeliveryInProgressOutForDeliveryOUT FOR DELIVERY
DeliveryInProgressShortDistanceSHORT DISTANCE DELIVERY
DeliveryAppointmentRequestedFIXED DATE FOR DELIVERYY
ExceptionDelayedIncorrectAddressSHIPMENT DELAYED - INCORRECT/INCOMPLETE ADDRESSY
ExceptionDelayedNotLoadedAsDangerousGoodsSHIPMENT DELAYED - NOT LOADED AS DANGEROUS GOODS
ExceptionMissingLostSHIPMENT LOST
ExceptionDelayedMissingSHIPMENT MISSING - PARTIALLY MISSING
ExceptionDelayedMissingUnderInvestigationSHIPMENT MISSING - UNDER INVESTIGATIONY
BookingCancelledOtherSHIPMENT CLOSED AS IT CANNOT BE DELIVERED
OtherSHIPMENT THEFT - UNDER INVESTIGATIONInclude in the description what happened
DeliveryCompletedPartlyPARTIALLY DELIVEREDY
ExceptionMissingUnderInvestigationShipperSHIPMENT MISSING - UNDER INVESTIGATION (SHIPPER)
ExceptionMissingUnderInvestigationCarrierSHIPMENT MISSING - UNDER INVESTIGATION (CARRIER)
PickupFailedOtherSHIPMENT DELAYED - NOT LOADED FOR TRANSPORT
ExceptionDelayedWrongRoutingSHIPMENT DELAYED - SORTED WRONG ROUTING
DeliveryPlannedRescheduledOnRequestOfRecipientSHIPMENT DELAYED - CONSIGNEE REQUESTED A NEW DELIVERY DATEY
DeliveryFailedAbsentRecipientSHIPMENT DELAYED - ABSENT CONSIGNEEY
DeliveryFailedWaitingTimeExceededSHIPMENT DELAYED - WAITING TIME AT CONSIGNEE EXCEEDEDY
DeliveryFailedRecipientMovedSHIPMENT DELAYED - CONSIGNEE MOVED
ExceptionDelayedAccidentACCIDENT/TRUCK BROKENY
ExceptionDelayedOtherSHIPMENT DELAYED - GOODS WERE HANDED OVER TO AGENT ON THE ISLAND
ExceptionDelayedAdministrativeRectivicationSHIPMENT DELAYED - ADMINISTRATIVE RECTIFICATION
ExceptionDelayedIncorrectLabellingSHIPMENT DELAYED - INCORRECT LABELY
ExceptionDelayedNotLoadedAsBondedGoodsSHIPMENT DELAYED - NOT LOADED AS CUSTOM BONDED GOODS
ExceptionDelayedWaitingForEdiSHIPMENT DELAYED - WAITING FOR EDI DATA
PickupFailedGoodsNotReadySHIPMENT DELAYED - WAITING FOR CONSIGNMENT
ExceptionDelayedBankHolidaySHIPMENT DELAYED - BANK HOLIDAYY
ExceptionDelayedBankHolidaySHIPMENT DELAYED - REGIONAL HOLIDAY
ExceptionDelayedForceMajeureSHIPMENT DELAYED - FORCE MAJOR
DeliveryFailedRecipientClosedSHIPMENT DELAYED - CONSIGNEE CLOSEDY
ExceptionDelayedIndustrialDisputeSHIPMENT DELAYED - INDUSTRIAL DISPUTE
DeliveryFailedAdditionalEquipmentRequiredSHIPMENT DELAYED - UNABLE TO DELIVER AS ADDITIONAL DEVICE WAS REQUIRED
ExceptionDelayedOtherSHIPMENT DELAYED - INCORRECT SHIPMENT DECLARATION AT GBW INTERMEDIATE HUB
ExceptionDelayedMissingDocumentsSHIPMENT DELAYED - MISSING DOCUMENTSY
ExceptionDelayedMissingDocumentsFromShipperSHIPMENT DELAYED - MISSING DOCUMENTS (SHIPPER)
ExceptionDelayedMissingDocumentsFromCarrierSHIPMENT DELAYED - MISSING DOCUMENTS (CARRIER)
ExceptionDelayedTemperatureExceededSHIPMENT DELAYED - TEMPERATURE EXCEEDED
ExceptionDelayedLackOfTransportCapacitySHIPMENT DELAYED - OVERLOAD, NOT FORWARDED
DeliveryCompletedPartlyMissingSHIPMENT MISSING - PARTIALLY DELIVEREDY
ExceptionReturnToSenderIncidentINCIDENT TRIGGERED FOR SHIPMENT BACK TO 3M
OtherSHIPMENT THEFT - PARTIALLY DELIVERED BILLEDInclude in the description what happened
ExceptionDelayedDeliveryAppointmentRequiredSHIPMENT DELAYED - DELIVERY APPOINTMENT NEEDEDY
DeliveryCompletedPartlyCustomerPickupCUSTOMER PICKUP - PARTIAL DELIVERY
BookingCancelledIncorrectInformationSHIPMENT CLOSED DUE TO INCORRECT INFORMATION FROM SHIPPER
DeliveryAppointmentRescheduledSHIPMENT DELAYED - DELIVERY APPOINTMENT
ExceptionDelayedOtherSHIPMENT DELAYED - SPECIFIC REASON FOR NON DELIVERY
ExceptionDelayedGeneralTimeConstraintSHIPMENT DELAYED - TIME CONSTRAINT
ExceptionDelayedMissedConnectionSHIPMENT DELAYED - TRUCK ARRIVED LATE AT THE INTERMEDIATE HUB
ExceptionDelayedUnknownSHIPMENT DELAYED - UNKNOWN REASONY
PickupFailedGoodsNotReadySHIPMENT DELAYED - WAITING TO BE COMPLETED AND SHIPPED
ExceptionMissingAtUnloadingIntermediateHubSHIPMENT DELAYED - MISSING AT THE TIME OF UNLOADING AT INTERMEDIATE HUB
OtherSHIPMENT SHORTAGEInclude in the description what happened
OtherDIFFERENT PALLET QUANTITIESInclude in the description what happened
OtherSHIPMENTS RECEIVED WITH EXTRA QUANTITYInclude in the description what happened
ExceptionReturnToSenderOtherSHIPMENT CLOSED - BACK TO 3MY
ExceptionDelayedLackOfUnloadingSpaceSHIPMENT DELAYED - LACK OF SPACE FOR DELIVERYY
TransitHubActivityArrivedARRIVAL AT THE HUBY
TransitHubActivityDepartedDEPARTURE FROM HUBY
TransitHubActivityDepartedDamagedDEPARTURE FROM HUB - DAMAGED
TransitHubActivityDepartedPartiallyMissingDEPARTURE FROM HUB - PARTIALLY MISSING
DeliveryCompletedPODY
DeliveryCompletedConsigneeIndicatesMissingPOD - CONSIGNEE INDICATES SHIPMENTS MISSING
DeliveryCompletedConsgineeIndicatesSurplusPOD - CONSIGNEE INDICATES SURPLUS
ExceptionDamagedDeliveredPOD - DAMAGED AND DELIVERED
DeliveryCompletedOtherPOD - DELIVERED WITH A SPECIFIC REASON
DeliveryCompletedManuallyRegisteredPOD - MANUALLY REGISTERED POD
DeliveryCompletedWithPermissionToLeaveGoodsPOD - NO SIGNED POD, DELIVERED WITH PERMIT TO PLACE GOODS
DeliveryCompletedDelayedSHIPMENT DELIVERED - WITH DELAY
PickupCompletedCustomerPickupCUSTOMER PICKUPY
DeliveryCompletedPartlyDamagedPARTIALLY DELIVERED AND PARTIALLY REFUSED DUE TO DAMAGE
DeliveryFailedRefusedByRecipientRequestedOtherDeliveryDateREFUSED BY CONSIGNEE - ANOTHER DELIVERY DATE
DeliveryFailedRefusedByRecipientSHIPMENT REFUSED BY CONSIGNEEY
DeliveryFailedRefusedByRecipientIncorrectContactDetailsSHIPMENT REFUSED BY CONSIGNEE - INCORRECT CONTACT DETAILS
DeliveryFailedRefusedByRecipientRequestedOtherDeliveryDateSHIPMENT REFUSED BY CONSIGNEE - ANOTHER DELIVERY DATEY
DeliveryFailedRefusedByRecipientDamagedSHIPMENT REFUSED BY CONSIGNEE - DAMAGEDY
DeliveryFailedRefusedByRecipientNotOrderedSHIPMENT REFUSED BY CONSIGNEE - DID NOT ORDER THE SHIPMENT
DeliveryFailedRefusedByRecipientMissingDocumentsSHIPMENT REFUSED BY CONSIGNEE - DOCUMENTS MISSING
DeliveryFailedRefusedByRecipientInventorySHIPMENT REFUSED BY CONSIGNEE - INVENTORY REASON
DeliveryFailedRefusedByRecipientLateDeliverySHIPMENT REFUSED BY CONSIGNEE - LATE DELIVERY
DeliveryFailedRefusedByRecipientShipmentIncompleteSHIPMENT REFUSED BY CONSIGNEE - MISSING
DeliveryFailedRefusedByRecipientCancelledSHIPMENT REFUSED BY CONSIGNEE - ORDER CANCELLED
ExceptionReturnToSenderPartiallySHIPMENT REFUSED BY CONSIGNEE - PARTIALLY BACK TO 3M
DeliveryFailedRefusedByRecipientShipmentIncompleteSHIPMENT REFUSED BY CONSIGNEE - PARTIALLY DELIVERED
DeliveryFailedRefusedByRecipientIncompleteDueToMissingSHIPMENT REFUSED BY CONSIGNEE - PARTIALLY MISSING
ExceptionReturnToSenderCancelledByShipperSHIPMENT REFUSED BY CONSIGNEE - BACK TO 3M (3M DECISION)
ExceptionReturnToSenderRefusedAtDeliverySHIPMENT REFUSED BY CONSIGNEE - BACK TO 3M (NON 3M DECISION)
TransitTransportIN TRANSITY

Note: Only deviate from the minimum tracking events in agreement with 3M.