Transfer and update shipment data, including milestone status, from Scope to customer
Top features
The Shipment Status Interface is an unidirectional outbound interface. It sends out shipment detail data, encompassing all milestone status which are ‘web-visible’, to the configured third parties involved in a shipment as customers, shippers, consignees, or notifiers. The interface caters all tracking-enabled operational shipments (and bookings) and is triggered by changes in shipment data, including modifications in the tracking plan of the shipment.
Prerequisite and technical information
A technical data communication channel is required between the Riege data center and the recipient of the shipment data. This channel gets a recipientID assigned by Riege. The recipientID is required for the setup in Scope.
All Scope branch offices are potential message senders and are assigned a senderID. The senderID default value is the code of the corresponding partner. The senderIDs should also be aligned with Riege for setup in the Riege internal message clearing system.
- The interface sends updates but no cancellation if the 3rd party is removed from the shipment
- Each change of shipment or tracking plan triggers a new transmissions to involved 3rd parties if they are configured as recipients.
- The description of the Scope Shipment Status Format is available at https://riege.github.io/xml-shipmentupdate
Scope Setup - EDI Profile
One EDI Profile is required for the Shipment Status Out interface.
For the EDI-profile the following rules apply:
- Code may be chosen freely
- Reference type code does not matter, typical values are 'ptt' or 'shipmentPtt' or 'usi'
- Type of interface must be set to 'Shipment Updates'
- Outgoing address mappings need to contain the own branch or all branch offices for the interface to trigger (every external ID here need to match a senderID).
- Outgoing address mappings need to contain all configured recipient partner with the external ID matching the recipientID.
Additional configuration in tracking templates is not required, any publicly visible milestones or exceptions are included in the tracking plan.
Any change to shipment or tracking plan triggers the transmission of a shipment status message. Scope uses a short delay to keep the message volume under control.