DataArea

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

Element information

Namespace: http://www.openapplications.org/oagis/10

Schema document: GetShipmentUnit.xsd

Type: GetShipmentUnitDataAreaType

Properties: Local, Qualified, ID: oagis-id-209709ad7261491f87b79ca4d391032f

Content

Sequence [1..1]
1. Get [1..1] The Get verb is to communicate to a business software component a request for an existing piece or pieces of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across the nouns it is paired with.The Get is designed to retrieval of information by using that information's primary retrieval field, or key field. The Get verb may also be used to request several documents at once. Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned.
2. ShipmentUnit [1..*] The ShipmentUnit represents a single track-able, uniquely identifiable assembly or container containing a specific collection of goods inventory that is packaged by a supplier for carrier transportation to a customer business partner destination The ShipmentUnit component identifies and describes the physical shipping container(s) and internal packaging structure of the delivered goods. The ShipmentUnit component is typically constructed to describe the result of an inventory picking and packing operation. A ShipmentUnit 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 track-able 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. The ShipmentUnit complements the line-item oriented summary information provided in the Shipment's ShipmentItem and InventoryDetail component with detailed information to accurately describe complex shipping unit assemblies and item packaging.

Attributes

None

Used in

Type GetShipmentUnitType (Element GetShipmentUnit)

Sample instance

<DataArea>
   <Get>
      <Expression>token</Expression>
   </Get>
   <ShipmentUnit>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <TrackingID>normalizedString</TrackingID>
      <ShipUnitSequenceID>normalizedString</ShipUnitSequenceID>
      <ShipUnitTotalID>normalizedString</ShipUnitTotalID>
      <ContainerGroupID>normalizedString</ContainerGroupID>
      <ContainerID>normalizedString</ContainerID>
      <RFID>normalizedString</RFID>
      <SealID>normalizedString</SealID>
      <Description/>
      <Note/>
      <DocumentReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </DocumentReference>
      <Attachment>
         <ID/>
         <IDSet>...
         </IDSet>
         <EmbeddedDataBinaryObject/>
         <URI>normalizedString</URI>
         <ISBN>normalizedString</ISBN>
         <FileName/>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <FileTypeCode>normalizedString</FileTypeCode>
         <FileSizeQuantity>1.0</FileSizeQuantity>
         <Title/>
         <Extension>.......................................
         </Extension>
      </Attachment>
      <CarrierParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </CarrierParty>
      <ShipFromParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <Extension>.......................................
         </Extension>
      </ShipFromParty>
      <ShipToParty>
         <ID/>
         <PartyIDSet>...
         </PartyIDSet>
         <TaxIDSet>...
         </TaxIDSet>
         <TaxID>normalizedString</TaxID>
         <DUNSID>normalizedString</DUNSID>
         <CAGEID>normalizedString</CAGEID>
         <DODAACID>normalizedString</DODAACID>
         <BICID>normalizedString</BICID>
         <SCACID>normalizedString</SCACID>
         <AccountID>normalizedString</AccountID>
         <Name/>
         <Location>...
         </Location>
         <Contact>...
         </Contact>
         <AppointmentRequiredIndicator>true</AppointmentRequiredIndicator>
         <Extension>.......................................
         </Extension>
      </ShipToParty>
      <DeclaredValueAmount/>
      <ShipmentDateTime></ShipmentDateTime>
      <ContainsHazardousMaterialIndicator>true</ContainsHazardousMaterialIndicator>
      <ExportLicenseRequiredIndicator>true</ExportLicenseRequiredIndicator>
      <ImportLicenseRequiredIndicator>true</ImportLicenseRequiredIndicator>
      <ScheduledDeliveryDateTime></ScheduledDeliveryDateTime>
      <ActualDeliveryDateTime></ActualDeliveryDateTime>
      <SpecialHandlingNote/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
      <TareWeightMeasure>1.0</TareWeightMeasure>
      <NetWeightMeasure>1.0</NetWeightMeasure>
      <GrossWeightMeasure>1.0</GrossWeightMeasure>
      <NetVolumeMeasure>1.0</NetVolumeMeasure>
      <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
      <DistributeCharge>
         <ID/>
         <IDSet>...
         </IDSet>
         <BasisAmount/>
         <BasisQuantity>1.0</BasisQuantity>
         <Description/>
         <Amount/>
         <Calculation>...
         </Calculation>
         <ReasonCode>normalizedString</ReasonCode>
         <CurrencyExchangeRate>...
         </CurrencyExchangeRate>
         <TimePeriod>..................
         </TimePeriod>
         <Distribution>...
         </Distribution>
         <Extension>.......................................
         </Extension>
      </DistributeCharge>
      <EstimatedFreightChargeAmount/>
      <FreightChargeAmount/>
      <SalePriceAmount/>
      <ShipmentTotalAmount/>
      <LoadingDateTime></LoadingDateTime>
      <EstimatedWeightMeasure>1.0</EstimatedWeightMeasure>
      <LoadingWeightMeasure>1.0</LoadingWeightMeasure>
      <Dimensions>
         <ID/>
         <IDSet>...
         </IDSet>
         <WidthMeasure>1.0</WidthMeasure>
         <LengthMeasure>1.0</LengthMeasure>
         <HeightMeasure>1.0</HeightMeasure>
         <Description/>
         <Measure/>
         <VolumeMeasure>1.0</VolumeMeasure>
         <NetVolumeMeasure>1.0</NetVolumeMeasure>
         <GrossVolumeMeasure>1.0</GrossVolumeMeasure>
         <DimensionRandomSizeIndicator>true</DimensionRandomSizeIndicator>
         <SizeLimitRange>...
         </SizeLimitRange>
         <WeightRange>...
         </WeightRange>
         <NetWeightMeasure>1.0</NetWeightMeasure>
         <TareWeightMeasure>1.0</TareWeightMeasure>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <Extension>.......................................
         </Extension>
      </Dimensions>
      <CountryOfOriginCode>token</CountryOfOriginCode>
      <DestinationCountryCode>token</DestinationCountryCode>
      <HazardousMaterialCodes>
         <Code/>
      </HazardousMaterialCodes>
      <TransportationMethodCode>normalizedString</TransportationMethodCode>
      <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode>
      <PointOfStagingCode>normalizedString</PointOfStagingCode>
      <TransportationTerm>
         <ID/>
         <IDSet>...
         </IDSet>
         <IncotermsCode>token</IncotermsCode>
         <PlaceOfOwnershipTransferLocation>...
         </PlaceOfOwnershipTransferLocation>
         <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode>
         <FreightTermCode>token</FreightTermCode>
         <Description/>
         <Note/>
         <FreightChargeGeographicLocationIndicator>true</FreightChargeGeographicLocationIndicator>
         <Extension>.......................................
         </Extension>
      </TransportationTerm>
      <TransportStep>
         <ID/>
         <IDSet>...
         </IDSet>
         <StartDateTime></StartDateTime>
         <EndDateTime></EndDateTime>
         <TransportationMethodCode>normalizedString</TransportationMethodCode>
         <TransportationTerm>...
         </TransportationTerm>
         <TransportationLotID>normalizedString</TransportationLotID>
         <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
         <TareWeightMeasure>1.0</TareWeightMeasure>
         <NetWeightMeasure>1.0</NetWeightMeasure>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <NetVolumeMeasure>1.0</NetVolumeMeasure>
         <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
         <Location>...
         </Location>
         <CarrierParty>...
         </CarrierParty>
         <Party>...
         </Party>
         <CarrierRouteReference>...
         </CarrierRouteReference>
         <Charge>...
         </Charge>
         <CarriersLogisticEquipment>...
         </CarriersLogisticEquipment>
         <ShippersLogisticEquipment>...
         </ShippersLogisticEquipment>
         <AssociatedLogisticEquipment>...
         </AssociatedLogisticEquipment>
         <Extension>.......................................
         </Extension>
      </TransportStep>
      <ExportLicense>
         <ID/>
         <IDSet>...
         </IDSet>
         <Classification>...
         </Classification>
         <ExpirationDate></ExpirationDate>
         <Extension>.......................................
         </Extension>
      </ExportLicense>
      <ShipToLocation>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </ShipToLocation>
      <PackingMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </PackingMaterial>
      <ShippingMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </ShippingMaterial>
      <ShipmentUnitContainer>
         <ID/>
         <IDSet>...
         </IDSet>
         <ContainerID>normalizedString</ContainerID>
         <RFID>normalizedString</RFID>
         <SealID>normalizedString</SealID>
         <ContainerGroupID>normalizedString</ContainerGroupID>
         <DocumentReference>...
         </DocumentReference>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <PackingMaterial>...
         </PackingMaterial>
         <ShippingMaterial>...
         </ShippingMaterial>
         <Quantity/>
         <ParentContainerID>normalizedString</ParentContainerID>
         <Description/>
         <Note/>
         <ShipmentUnitItem>...
         </ShipmentUnitItem>
         <Dimensions>...
         </Dimensions>
         <Extension>.......................................
         </Extension>
      </ShipmentUnitContainer>
      <ShipmentUnitItem>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <ItemIDSet>...
         </ItemIDSet>
         <CustomerItemIdentification>...
         </CustomerItemIdentification>
         <ManufacturerItemIdentification>...
         </ManufacturerItemIdentification>
         <SupplierItemIdentification>...
         </SupplierItemIdentification>
         <UPCID>normalizedString</UPCID>
         <EPCID>normalizedString</EPCID>
         <GTINID>normalizedString</GTINID>
         <UID>normalizedString</UID>
         <RFID>normalizedString</RFID>
         <SerialNumberID>normalizedString</SerialNumberID>
         <SerialLot>...
         </SerialLot>
         <ReferenceDesignatorID>normalizedString</ReferenceDesignatorID>
         <FindNumberID>normalizedString</FindNumberID>
         <Lot>...
         </Lot>
         <Quantity/>
         <Description/>
         <Note/>
         <Classification>...
         </Classification>
         <Specification>...
         </Specification>
         <HazardousMaterial>...
         </HazardousMaterial>
         <Packaging>...
         </Packaging>
         <Dimensions>...
         </Dimensions>
         <ExportControl>...
         </ExportControl>
         <HarmonizedTariff>...
         </HarmonizedTariff>
         <Trademark>...
         </Trademark>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <CountryOfOriginCode>token</CountryOfOriginCode>
         <ExportLicense>...
         </ExportLicense>
         <ContainsHazardousMaterialIndicator>true</ContainsHazardousMaterialIndicator>
         <HazardousMaterialCodes>...
         </HazardousMaterialCodes>
         <ImportLicenseRequiredIndicator>true</ImportLicenseRequiredIndicator>
         <OrderQuantity>1.0</OrderQuantity>
         <ShippedQuantity>1.0</ShippedQuantity>
         <OpenQuantity>1.0</OpenQuantity>
         <BackOrderedQuantity>1.0</BackOrderedQuantity>
         <OwnershipCode>normalizedString</OwnershipCode>
         <EstimatedWeightMeasure>1.0</EstimatedWeightMeasure>
         <LoadingWeightMeasure>1.0</LoadingWeightMeasure>
         <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
         <TareWeightMeasure>1.0</TareWeightMeasure>
         <NetWeightMeasure>1.0</NetWeightMeasure>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <NetVolumeMeasure>1.0</NetVolumeMeasure>
         <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
         <RequisitionReference>...
         </RequisitionReference>
         <PurchaseOrderReference>...
         </PurchaseOrderReference>
         <SalesOrderReference>...
         </SalesOrderReference>
         <ItemSubLine>...
         </ItemSubLine>
         <UnitSalePriceAmount/>
         <ExtendedSalePriceAmount/>
         <FreightItemID>normalizedString</FreightItemID>
         <FreightClassificationCode>normalizedString</FreightClassificationCode>
         <ShippingLabel>...
         </ShippingLabel>
         <Extension>.......................................
         </Extension>
      </ShipmentUnitItem>
      <ContainerQuantity>1.0</ContainerQuantity>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ShipmentUnit>
</DataArea>