Technical
description xml-shippingorder
Scope Shipping Order Interface
Purpose
Interface for Scope to receive shipment order data from forwarding customers (e.g. shippers) and convert them into Scope bookings.
For more details see https://service.riege.com/en/knowledge/shipping-order-interface.
Message format details
Protocol
The protocol is very simple: The sender sends a shipping order XML message according to the schema below. There isn’t any ackowledgement or receipt message flow in place.
The interface supports updates, primary key is the shippingOrderId element in the refs block of a shippingOrder element.
Message Structure
Multiple shipping orders may be sent in one envelope. However, these shipping orders must all be for the same recipient branch.
Schema definition
The schema definition of the message format can be found at the following link:
- Scope shippingorder version 3.3 xsd
- Scope shippingorder version 3.2 xsd
- Scope shippingorder version 3.1 xsd
- Scope shippingorder version 3.0 xsd
- Scope shippingorder version 2.4 xsd
- Scope shippingorder version 2.3 xsd
- Scope shippingorder version 2.2 xsd
- Scope shippingorder version 2.1 xsd
- Scope shippingorder version 2.0 xsd
- Scope shippingorder version 1.9 xsd
The schema definitions are also available via dtd.riege.com following the above version name scheme, e.g. version 2.4 available under
https://dtd.riege.com/scope/shippingorder/scope_shippingorder-2.4.xsd.
Message structure details
Field shippingOrderMessage/shippingOrder>/parties/pickupFrom is applicable to export shipping orders only. For an export shipping order, Scope creates a transport order for pickup from the pickup information provided. For non-export shipping orders, the field is ignored.
Field shippingOrderMessage/shippingOrder>/parties/deliverTo is applicable to import shipping orders only. For an import shipping order, Scope creates a transport order for delivers from the delivery information provided. For non-import shipping orders, the field is ignored.