CarrierRoute
Describes a scheduled journey that a particular goods transportation service provider (freight carrier) is requested to perform on the behalf of a shipper, customer or other transportation corrdinator. The journey may contain one or more stops. There are many possible business applications in several environments that may use this capability. A CarrierRoute is typically generated by a transportation planning system to coordinate and optimize the movement of many goods shipment to reduce overall freight cost, improve overall delivery schedules, and ensure that a carrier's equipment is utilized efficiently. Other business systems typically interested in a CarrierRoute document include supply chain execution, supply chain visibility, warehouse management, and transportaion management systems.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: Common.xsd
Type: CarrierRouteType
Properties: Global, Qualified, ID: oagis-id-fba85dc216c64363a2bddf35f5a267a5
Content
- Sequence [1..1]
- ID [0..1] 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.
- RevisionID [0..1] Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
- VariationID [0..1]
- DocumentIDSet [0..*]
- LastModificationDateTime [0..1] The datetime on which the object was last modified
- DocumentDateTime [0..1] The date that document was created within the system of record.
- Description [0..*]
- Note [0..*]
- DocumentReference [0..*]
- Attachment [0..*] The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
- 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.
- ActualShipDateTime [0..1] Inidicates the shipping date and time of the line item.
- ScheduledDeliveryDateTime [0..1] The scheduled delivery date provided by the supplier.
- ActualDeliveryDateTime [0..1] Is the actual delivery date and time of the line item.
- RequiredDeliveryDateTime [0..1] Indicates the date in which the buyer/customer requests the order to be delivered.
- PromisedDeliveryDateTime [0..1] Indicates the date in which the associated was promised to be delivered to the customer or consumer.
- LoadingDateTime [0..1] Identifies the date and time a shipment loading process is complete.
- EarliestShipDateTime [0..1] This indicates the earliest possible date at which a shipment can be made for the line item
- PromisedShipDateTime [0..1] Indicates the date in which the associated object was promised to be shipped from the supplier.
- ScheduledShipDateTime [0..1] The scheduled date to be shipped provided by the supplier.
- PointOfLoadingCode [0..1] Identifies the location shipped goods are to be loaded.
- PointOfShipmentCode [0..1] Identifies the location the goods are to be shipped.
- PointOfStagingCode [0..1] Identifies the location goods are to be placed prior to loading for shipment.
- TransportationMethodCode [0..1] Identifies the general type of carrier transportation used to deliver goods.
- TransportationTerm [0..1] The terms of the transportation agreement.
- 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.
- Container [0..1] Uniquely identifies a shipping container
- Status [0..1] Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
- Charge [0..1] 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.
- RouteStop [0..*] 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.
- 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.
from type DocumentIdentificationBaseTypefrom type HeaderBaseTypefrom group FreeFormTextGroupfrom group ReferencesGroupfrom type CarrierRouteBaseTypefrom group ShippingWeightAndVolumeGroup
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| typeCode | [0..1] | CodeType_1E7368 | from type CarrierRouteBaseType | |
| actionCode | [0..1] | ActionCodeContentType | from type CarrierRouteBaseType |
Used in
- Type AcknowledgeCarrierRouteDataAreaType (Element DataArea)
- Type CancelAcknowledgeCarrierRouteDataAreaType (Element DataArea)
- Type CancelCarrierRouteDataAreaType (Element DataArea)
- Type ChangeAcknowledgeCarrierRouteDataAreaType (Element DataArea)
- Type ChangeCarrierRouteDataAreaType (Element DataArea)
- Type GetCarrierRouteDataAreaType (Element DataArea)
- Type NotifyCarrierRouteDataAreaType (Element DataArea)
- Type ProcessCarrierRouteDataAreaType (Element DataArea)
- Type ShowCarrierRouteDataAreaType (Element DataArea)
- Type SyncCarrierRouteDataAreaType (Element DataArea)
- Type SyncResponseCarrierRouteDataAreaType (Element DataArea)
Sample instance
<CarrierRoute> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet> <ID/> </DocumentIDSet> <LastModificationDateTime></LastModificationDateTime> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <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> <Attachment> <ID/> <IDSet> <ID/> </IDSet> <EmbeddedDataBinaryObject/> <URI>normalizedString</URI> <ISBN>normalizedString</ISBN> <FileName/> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <FileTypeCode>normalizedString</FileTypeCode> <FileSizeQuantity>1.0</FileSizeQuantity> <Title/> <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> </Attachment> <TrackingID>normalizedString</TrackingID> <ActualShipDateTime></ActualShipDateTime> <ScheduledDeliveryDateTime></ScheduledDeliveryDateTime> <ActualDeliveryDateTime></ActualDeliveryDateTime> <RequiredDeliveryDateTime></RequiredDeliveryDateTime> <PromisedDeliveryDateTime></PromisedDeliveryDateTime> <LoadingDateTime></LoadingDateTime> <EarliestShipDateTime></EarliestShipDateTime> <PromisedShipDateTime></PromisedShipDateTime> <ScheduledShipDateTime></ScheduledShipDateTime> <PointOfLoadingCode>normalizedString</PointOfLoadingCode> <PointOfShipmentCode>normalizedString</PointOfShipmentCode> <PointOfStagingCode>normalizedString</PointOfStagingCode> <TransportationMethodCode>normalizedString</TransportationMethodCode> <TransportationTerm> <ID/> <IDSet> <ID/> </IDSet> <IncotermsCode>token</IncotermsCode> <PlaceOfOwnershipTransferLocation> <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> </PlaceOfOwnershipTransferLocation> <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode> <FreightTermCode>token</FreightTermCode> <Description/> <Note/> <FreightChargeGeographicLocationIndicator>true</FreightChargeGeographicLocationIndicator> <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> </TransportationTerm> <DunnageWeightMeasure>1.0</DunnageWeightMeasure> <TareWeightMeasure>1.0</TareWeightMeasure> <NetWeightMeasure>1.0</NetWeightMeasure> <GrossWeightMeasure>1.0</GrossWeightMeasure> <NetVolumeMeasure>1.0</NetVolumeMeasure> <TotalVolumeMeasure>1.0</TotalVolumeMeasure> <Container> <ID/> <IDSet> <ID/> </IDSet> <ContainerID>normalizedString</ContainerID> <RFID>normalizedString</RFID> <SealID>normalizedString</SealID> <ContainerGroupID>normalizedString</ContainerGroupID> <DocumentReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet>... </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status>... </Status> <LineNumberID/> <LineIDSet>... </LineIDSet> <Extension>....................................... </Extension> </DocumentReference> <GrossWeightMeasure>1.0</GrossWeightMeasure> <PackingMaterial> <ID/> <IDSet>... </IDSet> <Description/> <Note/> <Extension>....................................... </Extension> </PackingMaterial> <ShippingMaterial> <ID/> <IDSet>... </IDSet> <Description/> <Note/> <Extension>....................................... </Extension> </ShippingMaterial> <Quantity/> <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> </Container> <Status> <ID/> <IDSet> <ID/> </IDSet> <Code/> <Description/> <ReasonCode>normalizedString</ReasonCode> <Reason/> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime></StartDateTime> <StartTime>token</StartTime> <Duration>P1Y2M3DT10H</Duration> <EndDateTime></EndDateTime> <EndTime>token</EndTime> </EffectiveTimePeriod> <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> </Status> <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> <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>... </IDSet> <MFAGID>normalizedString</MFAGID> <TechnicalName/> <PlacardEndorsement/> <PlacardNotation/> <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode> <ToxicityZoneCode>normalizedString</ToxicityZoneCode> <Temperature/> <FlashpointTemperature>1.0</FlashpointTemperature> <PrimaryEntryRoute/> <Description/> <EmergencyContact>... </EmergencyContact> <HazardousClass/> <PackingGroup/> <Extension>....................................... </Extension> </HazardousMaterial> <Charge> <ID/> <IDSet>... </IDSet> <BasisAmount/> <BasisQuantity>1.0</BasisQuantity> <Description/> <Amount/> <Calculation>... </Calculation> <ReasonCode>normalizedString</ReasonCode> <CurrencyExchangeRate>... </CurrencyExchangeRate> <TimePeriod>.................. </TimePeriod> <Extension>....................................... </Extension> </Charge> <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> <DocumentReference> <ID/> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> <DocumentIDSet>... </DocumentIDSet> <DocumentDateTime></DocumentDateTime> <Description/> <Note/> <Status>... </Status> <LineNumberID/> <LineIDSet>... </LineIDSet> <Extension>....................................... </Extension> </DocumentReference> <StopDetail> <ID/> <IDSet>... </IDSet> <ContainerID>normalizedString</ContainerID> <Description/> <Note/> <TrackingID>normalizedString</TrackingID> <ShipToParty>... </ShipToParty> <Party>... </Party> <ShipUnitReference>... </ShipUnitReference> <ShipmentReference>... </ShipmentReference> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <BillOfLadingReference>... </BillOfLadingReference> <Extension>....................................... </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> <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> </CarrierRoute>