Schema Central > OAGIS® 10 > ShowShipment.xsd > ShowShipment
Advanced search
Need XML Help?

Recommended Reading:

Definitive XML Schema


Web Service Contract Design and Versioning for SOA


Advanced XML Applications



A Shipment is a business document that details the intent to transport a specific quantity of material goods from a supplier to a single customer business partner destination.  The Shipment has been modeled after similar proprietary documents on popular business software packages (SAP's Delivery Note, Oracle Applications' Delivery document, etc.)

A Shipment is typically derived from the shipping schedule associated with a customer's purchase or sales order, once overall demand and various other business factors which prioritize the availability of the supplier's goods inventory have been evaluated.

The Shipment document is designed to have a dynamic structure and content. Initial shipment planning information can be updated and significant detail (actual picked inventory attributes, ship unit packaging, etc.) may be added during the execution phase of the supplier's order fulfillment and shipping business processes.  

The final form of the Shipment document can provide detail about the carrier and level of service used to transport the material, the exact quantity and attributes of the material shipped, and how that material is physically packaged and identified for transport.   

To aid the customer's planning and receiving business processes, the supplier may transmit the final Shipment document to customer in advance so that they can prepare for carrier arrival and then efficiently accept and utilize the ordered material.  In this use case, the Shipment document may function as a traditional Advance Ship Notice (ASN).

A ShipUnit is a data element that identifies and describes a specific collection of goods inventory that is packaged by a supplier for carrier transportation to a customer business partner destination. 

A ShipUnit is generally the smallest "thing" that can be individually moved and tracked throughout a carrier's transportation network.  The physical size, inventory, content and internal nested container complexity within a ShipUnit is arbitrary.  The ShipUnit component was specifically designed to be transportation mode independent.  It may be used to represent any uniquely identifiable and trackable assembly, container or vessel including, but not limited to: a parcel express package; a pallet of identical or mixed items; a truck trailer, rail car or an ocean cargo container.

This BOD does not usually cause updates to occur.
Shipment Characteristics

A Shipment document does not necessarily have a one-to-one relationship with any customer purchase/sales order document, line item or line item schedule. For shipping efficiency, a Shipment document may consolidate inventory shipment requests from a variety of different orders that have the same ultimate physical destination.  In fact, there may be no customer sale at all, as when the supplier is simply transferring inventory from one warehouse site to another within their enterprise to maintain optimum stocking levels.  

A Shipment typically involves a minimum of three business partner entities: Supplier, Carrier, and Customer in the most common business transaction scenario.   However these partner titles are more useful as descriptions of the basic roles in the Shipment process.  The actual number and relationship of the potential business partners/parties involved in the transaction is intended to be flexible in usage to accommodate agents working on behalf of partners and unique or complex scenarios.

The ShipUnit component identify and describe the physical shipping container(s) and internal packaging structure of the delivered goods.  ShipUnit component are typically constructed to describe the result of an inventory picking and packing operation.

The ShipUnit structure complements the line-item oriented summary information provided in the Shipment's ShipItem and InventoryDetail component with detailed information to accurately describe complex shipping unit assemblies and item packaging.  This robust level of detail is often demanded by customers to improve the efficiency of their receiving operations.  If the supplier provides trustworthy ship unit packaging information in advance, the customer does not have to spend valuable receiving personnel time breaking down the containers to inspect and tally each inventory item.

The general industry trend toward smaller just-in-time deliveries of only the required amount of goods, customer-imposed packaging configurations and requirements, and suppliers performing value-added light assembly customization at the time of shipment is driving the need for more detailed information about the product as it is actually delivered.

Element information

Type: ShowShipmentType

Properties: Global, Qualified, ID: oagis-id-2055ddbdc11c42ae8fc8c592f31997af



Name Occ Type Description Notes
releaseID [1..1] NormalizedStringType OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on. from type BusinessObjectDocumentType
versionID [0..1] NormalizedStringType Indicates the version of the given BOD definition. from type BusinessObjectDocumentType
systemEnvironmentCode [0..1] SystemEnvironmentCodeContentType Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). Default value is "Production". from type BusinessObjectDocumentType
languageCode [0..1] LanguageCodeContentType Indicates the language that the contents of the BOD is in unless otherwise stated. Default value is "en-US". from type BusinessObjectDocumentType

Sample instance

<ShowShipment releaseID="normalizedString">
         <!--any element-->
            <!--any element-->

Site developed and hosted by Datypic, Inc.

Please report errors or comments about this site to