ShowShipment schema, example, validation rules, validation stylesheet

ShowShipment type: ShowShipment

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.

ShowShipment extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ShowShipmentDataArea

Is where the information that the BOD message carries is provided, in this case ShowShipment. The information consists of a Verb and one or more Nouns. The verb (Show) indicates the action to be performed on the Noun (Shipment).

ShowShipmentDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Shipment reference
Show reference

ShowShipment Scenario Diagram

Show schema

Show type: Show

The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types.

Show extends: ConfirmableVerb
Structure:

Shipment schema

Shipment type: Shipment

A Shipment document identifies and describes a specific collection of goods to be transported by a carrier and delivered to one or more business partner destinations. A Shipment document represents the extent and content of "transportation work" to be done by the carrier. For transportation efficiency, a shipment document typically consolidates deliveries to multiple destinations within a certain geographic region and may provide carrier routing instructions to each delivery stop.

Header type: Header

Provides general information about the document that is used to transport a specific quantity of material goods from a supplier to a single customer business partner destination.

ShipUnit type: ShipUnit

Provides information that identifies and describes a shipping unit assembly or container for shipment.

ShipItem type: ShipItem

Provides general information about the item inventory being delivered, including the planned and actual quantities. This information usually directly references a line item or shipment schedule line on a sales order, purchase order or other inventory transfer document.

Container type: Container

Provides information about an intermediate packaging level within the shipping unit.

ShipmentInventoryItem type: ShipmentInventoryItem

Provides a specific quantity of goods inventory packed within the ShipUnit or Container. This information usually references the related line item or shipment schedule on a sales order, purchase order or other inventory transfer document.

Container

All Container occurrences are required to have an identity (ContainerId) which is unique to all containers/packaging within the shipping unit. The ContainerId can be an actual unique physical identifier on the intermediate container/packaging or a logically unique construct of a business application. The latter method may be used when the intermediate container/packaging that has no unique physical identity, but a description of the nested relationship is still desired. The Container also contains an identity reference to its parent or outermost enclosing container (ParentContainerId). The parent container may be the ShipUnit container itself. When all ContainerID and ParentContianerId references within the ShipUnit are evaluated, the shipping unit's internal nested structure must form a spanning tree graph encompassing all defined Container and InventoryItem. No self-referencing or circular reference constructs are allowed. The spanning tree graph should accurately represent how all the containers and inventory items are physically packed within the shipping unit.

Structure:
Elements:
Name Type Description
ContainerId Id

Is the identifier of a container.

Generic identifier type with open qualifyingAgency.

ContainerSealId Id

Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.

Generic identifier type with open qualifyingAgency.

ContainerType Type

Is a classification of containers.

Description Description

Is a free-form description of the transaction or any portion of the transaction.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentReferences reference
Packaging Packaging

Identifies the Packaging information for a given item. Note: The UPC here is the UPC of the packaging for a given item.

ParentContainerID Id

Is the identifier of the container that physically holds other subordinate containers.

Generic identifier type with open qualifyingAgency.

ShipmentInventoryItem reference
UserArea reference

Header extends: SCEHeader
Structure:
Elements:
Name Type Description
Parties reference
ShipItem reference
UserArea reference

ShipItem extends: SCEItem
Structure:
Elements:
Name Type Description
BackOrderedQuantity Quantity

This is the quantity of product that is on back order.

A decimal value.

ExportLicenseRequired Indicator

Communicates the need for an export license on a good or service. Valid values are '0' for no license required, and '1' for license required.

Indicates if the semantic name is needed or not.

ExtendedPrice Amount

Is the total of the item amount multiplied by the number of items.

Simple content with the currency as an attrbute

ImportLicenseRequired Indicator

Communicates the need for an import license on a good or service. Valid values are '0' for no license required, and '1' for license required.

Indicates if the semantic name is needed or not.

InventoryDetail reference
ItemAmount Amount

Is the amount associated with an Item. It may be a cost, it may be an expense, or it may be a price. The meaning is based on the context in the instance of the BOD.

Simple content with the currency as an attrbute

ItemDescription Description

Contains the item description.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

ItemRevisionCode Code

Is the revision code for an Item. It is commonly used to indicate engineering changes to the item or product.

Base type for a Code of any kind

OpenQuantity Quantity

Is used to describe the quantity of item's, products or resources open to processing on a document header or line. The open quantity may refer to the quantity’s being budgeted, produced, purchased, received, sold, or used.

A decimal value.

OrderQuantity Quantity

Is the quantity of a material or product ordered by the customer.

A decimal value.

PackingMaterial PackingMaterial
PartialShipmentInd Indicator

Identifies when a partial shipment to a customer is allowed. Valid values are '0' for partial shipment not allowed.

Indicates if the semantic name is needed or not.

ShippedQuantity Quantity

This represents the actual quantity shipped.

A decimal value.

ShipPriorToDueDateInd Indicator

Communicates if it is permitted to ship a good or service prior to the date it is due. Valid values are '0' for no, and '1' for yes.

Indicates if the semantic name is needed or not.

ShipQuantity Quantity

This represents the actual quantity shipped.

A decimal value.

UserArea reference

Shipment extends: Noun
Structure:
Elements:
Name Type Description
Header reference
ShipUnit reference

ShipmentInventoryItem
Structure:
Elements:
Name Type Description
DocumentReferences reference
ExtendedPrice Amount

Is the total of the item amount multiplied by the number of items.

Simple content with the currency as an attrbute

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

FreightItemNumber Code

Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.

Base type for a Code of any kind

HazardousMaterial reference

Provides the Hazardous Material Code and description.

InventoryDetail reference
ItemAmount Amount

Is the amount associated with an Item. It may be a cost, it may be an expense, or it may be a price. The meaning is based on the context in the instance of the BOD.

Simple content with the currency as an attrbute

ItemDescription Description

Contains the item description.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

ItemIds reference
ItemQuantity Quantity

Is used to describe the quantity of item’s, products or resources being budgeted, produced, purchased, received, sold, or used.

A decimal value.

LotSerial reference
OriginationCountry Country

Represents the identifier of the country of origin. The list of valid codes can be found in ISO Standard number 3166.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

OwnershipCode Code

Is used to identify who or which organization owns the item or part. The content of this Field is user defined based on a specific Customer or Supplier.

Base type for a Code of any kind

Packaging reference

Identifies the Packaging information for a given item. Note: The UPC here is the UPC of the packaging for a given item.

UserArea reference

ShipUnit extends: SCEUnit

The ShipUnit supports the optional capability to accurately describe the internal intermediate container and item packaging structure with the shipping unit to any arbitrary complexity or nesting depth

Structure:
Elements:
Name Type Description
Container reference
Parties reference
ShipmentInventoryItem reference
UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files

SupplyChainExecution.xsd schema

InventoryDetail type: LotSerial

Provides additional inventory attribute information for an inventory item, such as lot numbers, quality/disposition, serial numbers, or other characteristics that may not be specified on the order documentation.

ShipmentDocumentReference type: ShipmentDocumentReference

Is a reference to a Shipment.

OwnershipCode type: OwnershipCode

is used to identify who or which organization owns the item or part. The content of this Field is user defined based on a specific Customer or Supplier. SYNONYMS: Vendor Consignment ID, Supplier Consignment ID

Idenifies who owns the associated entity.

FreightClass type: FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

CatchWeightQuantity type: Quantity

This is the actual weight of the ReceivedQuantity for the Item, if the NetWeightQuantity cannot be calculated precisely via arithmetic because the goods do not have a consistent per unit weight

A decimal value.

CatchWeightConversionFactor type: Factor

The catch weight conversion factor is a stock keeping conversion factor for inventory goods. This is a special conversion factor for when the units of measure can not be converted using arithmetic. This conversion factor is used with the CatchWeightQuantity. Examples of the use of this factor include: - Number of Chickens to a Box - Number of units of a chemical in a barrel

NetWeight type: Quantity

This is the total net weight of the ReceivedQuantity for the Item, if the ReceivedQuantity is not in weight units. This is the weight of the goods received, disregarding any container or shipping packaging

A decimal value.

OriginationCountry type: Country

Is the country in which the Shipment originated.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

ShipUnitReference type: ShipUnitReference

SCEHeader
Structure:
Elements:
Name Type Description
ActualFreightTotalCost Amount

Is used to report the total price charged to the customer for transporting the items or products being sold, produced or purchased. This amount is determined by the shipping partner and/or reported by the carrier partner upon shipment or delivery of the product.

Simple content with the currency as an attrbute

AlternateDocumentIds DocumentIds

Other document identifiers this document maybe known as. This provides a cross-reference to the other parties identifiers for this document.

Charges reference
Description Description

Is a free-form description of the transaction or any portion of the transaction.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDate DateTime

Is the timestamp that the document was created in the sending system.

DocumentId DocumentIdType

Is a general identifier of a document number.

EarliestShipDateTime DateTime

This identifies the earliest possible date at which a shipment can be made. This may be used in conjunction with the ShipPriorToDueDateInd which indicates that the item, shipping unit or delivery may be shipped early.

LastModificationDateTime DateTime

Is the date of the last update to this document.

OriginationCountry Country

Represents the identifier of the country of origin. The list of valid codes can be found in ISO Standard number 3166.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

PartialShipmentInd Indicator

Identifies when a partial shipment to a customer is allowed. Valid values are '0' for partial shipment not allowed.

Indicates if the semantic name is needed or not.

Priority Priority

Priority of a document, task, or activity. Could be used for production orders, sales orders, purchase orders, etc.

ShipUnitQuantity Quantity

Contains the quantity of units or things shipped. This represents the container(s), not the product shipped. An example of this is "4 truck loads" or "2 wooden crates".

A decimal value.

TotalFreightCost Amount

MDV: How is this different to ActualFreightTotalAmount?

Simple content with the currency as an attrbute

Warehouse Warehouse

Is the storage facility for inventory.

SCEItem
Structure:
Elements:
Name Type Description
CatchWeightConversionFactor reference
CatchWeightQuantity reference
Charges reference
FreightClass reference

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

HazardousMaterial reference

Provides the Hazardous Material Code and description.

Item reference
LotSerial reference
NetWeight reference
OriginationCountry reference
OwnershipCode reference

Idenifies who owns the associated entity.

RoutingDisposition reference

SCEUnit extends: Noun
Structure:
Elements:
Name Type Description
Charges reference
ContainerId Id

Is the identifier of a container.

Generic identifier type with open qualifyingAgency.

ContainerSealId Id

Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.

Generic identifier type with open qualifyingAgency.

ContainerType Type

Is a classification of containers.

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Disposition reference

Used to indicate that a particular shipping unit has been received

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

FreightItemNumber Code

Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.

Base type for a Code of any kind

ShippersCost AmountPerQuantity

Is used to describe the shipper's total cost of transporting the items or products being sold, produced or purchased, if it is different that the freight amount being charged to the customer. (Certain businesses may want to track the internal cost of a free shipping promotion or utilize their shipping operations as a profit center.) To report the total freight charge the customer is to pay, use FreightAmount.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

ShippingMaterial reference

Is an identifier is the part number of a shipping container or material.

ShippingTrackingId Id

Is a unique identifier for the purpose of tracking an individual package or shipment. Examples of valid TrackingIds are: - An express parcel tracking nmber at typicall assigned by UPS, DHL, Federal Express or other similar carriers. - A UCC (Uniform Code Council) Serialized Shipping Container (SCC-18) identifier, as assigned by the shipper. - A "Pro Number" (Progressive Number), as assigned by an LTL (less-than-truckload) freight carrier. Since the same Pro Number can be assigned to multiple shipping units within an LTL shipment the ShipUnitSequence and ShipUnitTotal identifiers may be used to identify the individual pieces. - The unique identifier of a motor freight trailer or railroad box or tank car, ocean freight container or other transportation vessel.

Generic identifier type with open qualifyingAgency.

ShipUnitSequence SequenceCode

In a set of similar shipping units for a delivery, ShipUnitSequenceId represents a particular unit out of the total set. When used in conjunction with ShipUnitTotalId and printed on a shipping unit label or packing list, the receiving partner can easily ascertain whether or not the delivery was complete.

ShipUnitTotalId Id

In a set of similar shipping units for a delivery, ShipUnitTotalId represents the total or final unit in the set. When used in conjunction with ShipUnitSequenceId and printed on a shipping unit label or packing list, the receiving partner can easily ascertain whether or not the delivery was complete.

Generic identifier type with open qualifyingAgency.

TotalVolume Quantity

Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.

A decimal value.

TotalWeight Quantity

Quantifies the weight, or heaviness, of an item, container or shipment.

A decimal value.

ShipmentDocumentReference extends: DocumentReference

Is a reference to a Shipment document.

Structure:
Elements:
Name Type Description
DocumentDate DateTimeAny

The Datetime of the referenced document.

DocumentIds reference
ShipUnitReference reference
UserArea reference

ShipUnitReference
Structure:
Elements:
Name Type Description
ContainerId Id

Is the identifier of a container.

Generic identifier type with open qualifyingAgency.

ContainerSealId Id

Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.

Generic identifier type with open qualifyingAgency.

ContainerType Type

Is a classification of containers.

FreightItemNumber Code

Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.

Base type for a Code of any kind

ShippingTrackingId Id

Is a unique identifier for the purpose of tracking an individual package or shipment.

Generic identifier type with open qualifyingAgency.

UserArea reference