RouteStop

Provides information pertaining to a particular pickup or delivery stop along the journey of a routed shipment.

Each instance of the RouteStop pertains to a single physical destination shipping location and requires a subordinate ShipToParty.

Element information

Content

• Sequence [1..1]
  from type IdentificationType
  ID [0..*]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  IDSet [0..*]    
  from type RouteStopBaseType
  TrackingID [0..1]    TRACKINGID is a unique identifier for the purpose of tracking an individual package or shipment Examples of a valid TRACKINGID include: •An express parcel tracking number as typically assigned by UPS, DHL, Fedex 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 SHIPUNITSEQ and SHIPUNITTOT field identifiers may be used to identify the individual pieces. •The unique identifier of a motor freight trailer, railroad box or tank car, ocean freight container or other transportation vessel.
  ContainerID [0..*]    The unique identifier of a container that holds the associated entity. A container is typically used for shipping material. Whether they be raw material or finished goods or piece parts.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  from group ShippingWeightAndVolumeGroup
  DunnageWeightMeasure [0..1]    Specifies details of the shipped unit weight
  TareWeightMeasure [0..1]    Tare weight of the associated Entity. The Tare weight is the weight of the packaging when empty (in the case of a pallet the weight of the empty pallet) that when subtracted from the Gross weight results in the Net weight.
  NetWeightMeasure [0..1]    Net weight of the associaed item. The net weight is calculated by subtracting the tare weight or the weight of the container from the GrossWeight.
  GrossWeightMeasure [0..1]    Gross weight of the associated entity. The total weight of the entity without reduction of packaging or container. I.e The Gross wieght of a pallet of goods includes the weight of the pallet.
  NetVolumeMeasure [0..1]    
  TotalVolumeMeasure [0..1]    Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.
  HazardousMaterial [0..*]    Provides the Hazardous Material Code and description.
  Charge [0..*]    Specifies the details for Charges that may be applied to the associated transaction
  Party [0..*]    A generic Party for non-validated or application-validated parties. A work-around for situations where Schema-validation of Parties is not feasible or not desired.
  DocumentReference [0..*]    
  StopDetail [0..*]    
  1. Extension [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type CarrierRouteBaseType
• Type CarrierRouteType via extension of CarrierRouteBaseType (Element CarrierRoute)

Sample instance

<RouteStop>
   <ID/>
   <IDSet>
      <ID/>
   </IDSet>
   <TrackingID>normalizedString</TrackingID>
   <ContainerID>normalizedString</ContainerID>
   <Description/>
   <Note/>
   <DunnageWeightMeasure>1.0</DunnageWeightMeasure>
   <TareWeightMeasure>1.0</TareWeightMeasure>
   <NetWeightMeasure>1.0</NetWeightMeasure>
   <GrossWeightMeasure>1.0</GrossWeightMeasure>
   <NetVolumeMeasure>1.0</NetVolumeMeasure>
   <TotalVolumeMeasure>1.0</TotalVolumeMeasure>
   <HazardousMaterial>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <MFAGID>normalizedString</MFAGID>
      <TechnicalName/>
      <PlacardEndorsement/>
      <PlacardNotation/>
      <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode>
      <ToxicityZoneCode>normalizedString</ToxicityZoneCode>
      <Temperature/>
      <FlashpointTemperature>1.0</FlashpointTemperature>
      <PrimaryEntryRoute/>
      <Description/>
      <EmergencyContact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </EmergencyContact>
      <HazardousClass/>
      <PackingGroup/>
      <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>
   </HazardousMaterial>
   <Charge>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <BasisAmount/>
      <BasisQuantity>1.0</BasisQuantity>
      <Description/>
      <Amount/>
      <Calculation>
         <ID/>
         <IDSet>...
         </IDSet>
         <Formula/>
         <RateNumber>1.0</RateNumber>
         <Description/>
         <ApplicableTimePeriod>..................
         </ApplicableTimePeriod>
         <Extension>.......................................
         </Extension>
      </Calculation>
      <ReasonCode>normalizedString</ReasonCode>
      <CurrencyExchangeRate>
         <ID/>
         <IDSet>...
         </IDSet>
         <SourceCurrencyCode>token</SourceCurrencyCode>
         <SourceUnitBaseNumber>1.0</SourceUnitBaseNumber>
         <TargetCurrencyCode>token</TargetCurrencyCode>
         <TargetUnitBaseNumber>1.0</TargetUnitBaseNumber>
         <RateNumber>1.0</RateNumber>
         <SetDateTime></SetDateTime>
         <SourceID>normalizedString</SourceID>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </CurrencyExchangeRate>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </TimePeriod>
      <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>
   </Charge>
   <Party>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <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>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <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>
   </Party>
   <DocumentReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <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>
   </DocumentReference>
   <StopDetail>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <ContainerID>normalizedString</ContainerID>
      <Description/>
      <Note/>
      <TrackingID>normalizedString</TrackingID>
      <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>
      <Party>
         <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>
      </Party>
      <ShipUnitReference>
         <ID/>
         <IDSet>...
         </IDSet>
         <SealID>normalizedString</SealID>
         <FreightItemID>normalizedString</FreightItemID>
         <ShippingTrackingID>normalizedString</ShippingTrackingID>
         <Extension>.......................................
         </Extension>
      </ShipUnitReference>
      <ShipmentReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <ShipUnitReference>...
         </ShipUnitReference>
         <Extension>.......................................
         </Extension>
      </ShipmentReference>
      <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>
      <BillOfLadingReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </BillOfLadingReference>
      <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>
   </StopDetail>
   <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>
</RouteStop>