Technical
description xml-warehouse
Scope Warehouse Interface
Purpose
The purpose of the Scope Warehouse Interface is to provide a way for Scope-using forwarders to exchange shipment-related data with their handling agent partners.
For more details see https://service.riege.com/en/knowledge/wms-interface-for-shipment-data.
As a complementary we advice to enable the Scope Event Interface to allow handling agent partners to feed back status updates into Scope.
Message format details
Protocol
Scopes sends a shipment data XML message according to the schema below.
The Scope Warehouse XML interface is active for each external partner (i.e. not a Scope branch) relevant in the shipment and having a valid setup in the “Warehouse” EDI Profile. Whether or not Scope considers a party relevant, depends on the message and other factors. Here are the most common conditions; party is:
- Export warehouse
- Import warehouse
- Pickup address of a related transport order
- Delivery address of a related transport order
The handling agent partner may supply event data using Scope Event XML messages.
More complex messages from the handling agent partner to Scope-using forwarder are included in this schema (version 6.0 and above).
This interface does not support any technical or functional receipt message flow.
Schema definition
The schema definitions are also available via dtd.riege.com following the
above version name scheme, e.g. version 6.0 available under
https://dtd.riege.com/scope/warehouse/scope_warehouse-6.0.xsd.
Shipment pre-advice (warehouseShipment / deleteShipment, Scope → Warehouse)
The warehouseShipment is an advice with shipment data for goods expected to
arrive at the handling agent. Even though multiple reference of any kind are
available, the shipmentID element holds the functional reference required for
any further communication.
A warehouseShipment message is sent to a relevant party (see above), whenever
the shipment in Scope is changed. We implemented a short delay to prevent
communication partners from being flooded with updates when a shipment is stored
frequently within a short amount of time.
The deleteShipment is a cancellation of a previous advised
warehouseShipment, identified by the shipmentID. The message is sent to each
party when the shipment is marked as cancelled, or if the party is no longer
relevant (e.g. when the export warehouse was changed).
Screening report (screeningReport, Warehouse → Scope)
The screeningReport is used to convey the results of an (air security)
screening operation. It includes most of the details of a Consignment Security
Declaration, most importantly the security status of the shipment after the
screening operation.
ULD build order (uldBuildOrder, Scope → Warehouse)
When a forwarder wishes to instruct their handling agent party to prepare built-up pallets (BUPs) for a shipment, they can issue a ULD build order. It contains basic information about the shipment (AWB number, LAT, etc.), the cargo to be loaded, the equipment to use and optional instructions, e.g. contour codes.
The uldBuildOrder message is sent when a Scope user creates the ULD Build
Order document.
ULD build result (uldBuildResult, Warehouse → Scope)
The uldBuildResult is used to inform the forwarder about the results of a ULD
build order. It contains details about the BUPs (e.g. serial number, total gross
weight) and their loaded cargo. This data is then available on the ULD tab of
the related shipment.
Warehouse receipt advice (warehouseReceiptAdvice, Scope → Warehouse)
The warehouseReceiptAdvice is a message to inform a handling agent partner
about an imminent delivery to their warehouse. It may comprise multiple
(potentially partial) consignments of shipments, which are identified by their
shipmentID.
Warehouse manifest (warehouseManifest, Scope → Warehouse)
The warehouseManifest is used to inform the handling partner about a
consolidation, i.e. multiple shipments consolidated on another (Super House or
Master) shipment. All shipments are identify by their shipmentID.
The warehouseManifest message is sent when a Scope user creates the
corresponding Warehouse Manifest document.
Warehouse receipt (warehouseReceipt, Scope Handling → Forwarder)
obsolete
Warehouse load (warehouseLoad, Scope Handling → Forwarder)
obsolete
Validation
Make sure your messages are valid according to the XML schema.
In addition to validating against XML schema, we perform some very basic checks, e.g. that message time stamps are not from the future.
Entity Resolution for messages send to Scope
Scope identifies an entity by the shipmentID initially send by messages from
Scope to the Warehouse. See also:
Entity resolution for inbound events.