Recommended Reading:
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.
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/Nouns/CarrierRoute.xsd
Type: CarrierRouteType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- Sequence
[0..1]
- DocumentID [0..1] Is the primary document id for the document associated.
- AlternateDocumentID [0..*] Is the alternate document id for the associated document.
- 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.
- Sequence
[0..1]
- Description [0..*]
- Note [0..*]
- Sequence
[0..1]
- 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.
- RouteType [0..1]
- ActualShipDateTime [0..1] Is the date that is used to identify the actual date and time a shipment occurs.Is the date that is used to identify the actual date and time a shipment occurs.
- 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] Is the date that the business partner is requesting delivery of goods to arrive.Is the date that the business partner is requesting delivery of goods to arrive.
- PromisedDeliveryDateTime [0..1] Is the date that the supplier business partner promises delivery of goodsIs the date that the business partner is supplying goods promises delivery of goods to arrive.
- LoadingDateTime [0..1] Is the date that is used to mark the date and time a shipment loading process is complete.Is the date that is used to mark the date and time a shipment loading process is complete.
- EarliestShipDateTime [0..1] 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.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.
- PromisedShipDateTime [0..1] Is the date the business partner supplying goods is promising goods to be shipped.
- ScheduledShipDateTime [0..1] Identifies the date on which the goods are scheduled to be shipped.
- 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] When a seller ships something via common to a buyer in accordance with the Uniform Commerical Code and international legal agreements, you must specify a particular "phrase" that states who assumes the risk of shipment, who is responsible for loading and unloading the goods, where ownership or title to the goods passes, who paid or pays the carrirer, etc. Examples of these "phrases" include: - "FOB Origin Prepaid and Add" (Free On Board - no cost for loading, title passes at seller's dock, seller prepaid freight cost and delivery insurance, seller will freight costs to cost of goods) - "FOB Destination" or "FOB Destination Prepaid" (Free On Board - no cost for loading, title passes at buyer's dock, seller prepaid freight cost and delivery insurance) In software applications, this phrase is commonly split into two coded pieces, a "legal terms" risk and responsibility component for use with common carriers (FOB Destination) and some kind of qualifying component (Prepaid and Add).
- Sequence
[0..1]
- 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] This is the net weight of the goods or materials being shipped.
- 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.
- 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] Represents the different Charges that may be applied to the associated document.
- 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.
- UserArea [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 USERAREA is always the last element in all components, except where the component has been extended inline.
from type HeaderTypefrom group DocumentIDsGroupfrom group FreeFormTextGroupfrom group ReferencesGroupfrom group ShippingWeightAndVolumeGroup - Sequence
[0..1]
Attributes
None
Used in
- Type GetCarrierRouteDataAreaType (Element DataArea)
- Type NotifyCarrierRouteDataAreaType (Element DataArea)
- Type OAGIS9NounsType (Element OAGIS9Nouns)
- Type ShowCarrierRouteDataAreaType (Element DataArea)
- Type SyncCarrierRouteDataAreaType (Element DataArea)
Sample instance
<CarrierRoute> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <LastModificationDateTime>2000-01-01</LastModificationDateTime> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <DocumentReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs>... </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address>... </Address> <Coordinate>... </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </IssuingParty> <OperationReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <UserArea> <!--any element--> </UserArea> </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <UserArea> <!--any element--> </UserArea> </ShipUnitReference> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </EffectiveTimePeriod> <Item> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot>... </Lot> <UserArea> <!--any element--> </UserArea> </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <Attachment> <EmbeddedData mimeCode="normalizedString">GpM7</EmbeddedData> <URI>http://www.example.com/</URI> <ISBN>normalizedString</ISBN> <FileName>string</FileName> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <FileType>normalizedString</FileType> <FileSizeQuantity>1.0</FileSizeQuantity> <Title>string</Title> <UserArea> <!--any element--> </UserArea> </Attachment> <TrackingID>normalizedString</TrackingID> <RouteType>normalizedString</RouteType> <ActualShipDateTime>2000-01-01</ActualShipDateTime> <ScheduledDeliveryDateTime>2000-01-01</ScheduledDeliveryDateTime> <ActualDeliveryDateTime>2000-01-01</ActualDeliveryDateTime> <RequiredDeliveryDateTime>2000-01-01</RequiredDeliveryDateTime> <PromisedDeliveryDateTime>2000-01-01</PromisedDeliveryDateTime> <LoadingDateTime>2000-01-01</LoadingDateTime> <EarliestShipDateTime>2000-01-01</EarliestShipDateTime> <PromisedShipDateTime>2000-01-01</PromisedShipDateTime> <ScheduledShipDateTime>2000-01-01</ScheduledShipDateTime> <PointOfLoadingCode>normalizedString</PointOfLoadingCode> <PointOfShipmentCode>normalizedString</PointOfShipmentCode> <PointOfStagingCode>normalizedString</PointOfStagingCode> <TransportationMethodCode>normalizedString</TransportationMethodCode> <TransportationTerm> <IncotermsCode>normalizedString</IncotermsCode> <PlaceOfOwnershipTransferLocation> <ID>normalizedString</ID> <Name>string</Name> <Directions>string</Directions> <Coordinate>... </Coordinate> <Address>... </Address> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </PlaceOfOwnershipTransferLocation> <ShipmentServiceLevelCode>normalizedString</ShipmentServiceLevelCode> <FreightTermCode>normalizedString</FreightTermCode> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </TransportationTerm> <TareWeightMeasure unitCode="normalizedString">1.0</TareWeightMeasure> <NetWeightMeasure unitCode="normalizedString">1.0</NetWeightMeasure> <GrossWeightMeasure unitCode="normalizedString">1.0</GrossWeightMeasure> <TotalVolumeMeasure unitCode="normalizedString">1.0</TotalVolumeMeasure> <Container> <ContainerID>normalizedString</ContainerID> <RFID>normalizedString</RFID> <SealID>normalizedString</SealID> <ContainerGroupID>normalizedString</ContainerGroupID> <PackingMaterial> <ID>normalizedString</ID> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </PackingMaterial> <ShippingMaterial> <ID>normalizedString</ID> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </ShippingMaterial> <UserArea> <!--any element--> </UserArea> </Container> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <Charge> <ID>normalizedString</ID> <BasisAmount currencyID="AED">1.0</BasisAmount> <Description>string</Description> <Amount currencyID="AED">1.0</Amount> <Calculation> <RateNumeric>1.0</RateNumeric> <Description>string</Description> <UserArea> <!--any element--> </UserArea> </Calculation> <ReasonCode>normalizedString</ReasonCode> <CurrencyExchangeRate> <SourceCurrencyCode>AED</SourceCurrencyCode> <SourceUnitBaseNumeric>1.0</SourceUnitBaseNumeric> <TargetCurrencyCode>AED</TargetCurrencyCode> <TargetUnitBaseNumeric>1.0</TargetUnitBaseNumeric> <RateNumeric>1.0</RateNumeric> <SetDateTime>2000-01-01</SetDateTime> <SourceID>normalizedString</SourceID> <EffectiveTimePeriod>... </EffectiveTimePeriod> <UserArea> <!--any element--> </UserArea> </CurrencyExchangeRate> <TimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <UserArea> <!--any element--> </UserArea> </Charge> <Party> <PartyIDs> <ID>normalizedString</ID> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location> <ID>normalizedString</ID> <Name>string</Name> <Directions>string</Directions> <Coordinate>... </Coordinate> <Address>... </Address> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Location> <Contact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </Contact> <UserArea> <!--any element--> </UserArea> </Party> <RouteStop> <ID>normalizedString</ID> <SequenceCode>normalizedString</SequenceCode> <TrackingID>normalizedString</TrackingID> <ContainerID>normalizedString</ContainerID> <Description>string</Description> <Note>string</Note> <TareWeightMeasure unitCode="normalizedString">1.0</TareWeightMeasure> <NetWeightMeasure unitCode="normalizedString">1.0</NetWeightMeasure> <GrossWeightMeasure unitCode="normalizedString">1.0</GrossWeightMeasure> <TotalVolumeMeasure unitCode="normalizedString">1.0</TotalVolumeMeasure> <HazardousMaterial> <ID>normalizedString</ID> <MFAGID>normalizedString</MFAGID> <TechnicalName>string</TechnicalName> <PlacardEndorsement>string</PlacardEndorsement> <PlacardNotation>string</PlacardNotation> <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode> <ToxicityZoneCode>normalizedString</ToxicityZoneCode> <Temperature unitCode="normalizedString">1.0</Temperature> <FlashpointTemperature unitCode="normalizedString">1.0</FlashpointTemperature> <PrimaryEntryRoute>string</PrimaryEntryRoute> <Description>string</Description> <EmergencyContact>... </EmergencyContact> <UserArea> <!--any element--> </UserArea> </HazardousMaterial> <Charge> <ID>normalizedString</ID> <BasisAmount currencyID="AED">1.0</BasisAmount> <Description>string</Description> <Amount currencyID="AED">1.0</Amount> <Calculation>... </Calculation> <ReasonCode>normalizedString</ReasonCode> <CurrencyExchangeRate>... </CurrencyExchangeRate> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Charge> <Party> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </Party> <DocumentReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs>... </ItemIDs> <Facility>... </Facility> <SerializedLot>... </SerializedLot> <SalesOrderReference>... </SalesOrderReference> <PurchaseOrderReference>... </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty>... </IssuingParty> <OperationReference>... </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference>... </ShipUnitReference> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Item>... </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <StopDetail> <BillOfLadingID>normalizedString</BillOfLadingID> <ContainerID>normalizedString</ContainerID> <Description>string</Description> <Note>string</Note> <TrackingID>normalizedString</TrackingID> <ShipToParty>... </ShipToParty> <Party>... </Party> <ShipUnitReference>... </ShipUnitReference> <ShipmentReference>... </ShipmentReference> <DocumentReference>... </DocumentReference> <Attachment>... </Attachment> <BillOfLadingReference>... </BillOfLadingReference> <UserArea> <!--any element--> </UserArea> </StopDetail> <UserArea> <!--any element--> </UserArea> </RouteStop> <UserArea> <!--any element--> </UserArea> </CarrierRoute>