PartsOrderHeader

Uses the Component:PartsOrderHeaderType

Parts Order Header

Fields and Components

Table 7.2. Fields and Components

Name Description Occurrence Type Data Type User Notes
DocumentDateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

0..1Field udt:DateTimeType  
SecondaryPassword

Secondary password used to validate access to the dealer information

0..1Field udt:TextType  
SecondaryDealerNumberID

Identifies secondary dealer number if different than primary "Dealer Number"

0..1Field udt:IdentifierType  
DocumentIdentificationGroup

A group of identifications that uniquely identifies this document

1..1ComponentDocumentIdentificationGroupType 
TaxabilityIndicator

Determines whether an item or amount is taxable.

0..1Field udt:IndicatorType  
PromisedDeliveryDate

Indicates the date in which the order was promised to be delivered to the dealer. This is the default unless specified otherwise at the lineitem level.

0..1Field udt:DateType  
PromisedShipDate

Indicates the date in which the order was promised to be shipped from the supplier to the dealer. This is the default unless specified otherwise at the lineitem. level.

0..1Field udt:DateType  
AcknowledgmentDetail

Deprecated. Use: AcknowledgmentStatus

0..1ComponentAcknowledgmentDetailType 
PaymentTerms

The PaymentTerms component represents the payment due dates and payment discount information.

0..1ComponentPaymentTermsType 
OrderTypeCode

Part Order Type entered or selected at dealership. Stock-STK, Vehicle Off Road-VOR, Daily-DPO, Emergency-EMG, Supplemental-SUP, Promotional-PRO, Solicited-SOL, Vehicle Off Road Parts Inquiry-VPI, Weekly-WKL, Interim-INT, Export-EXP, Dropship Stock-DSS, Dropship Vehicle Off Road-DVR, Lock and Key-LAK, Will Call-WCL, Return Request w/ Reference-RRR, Return Request w/o Reference-RWR, Credit Request w/ Reference-CRR, Credit Request w/o Reference-CWR, Debit Request w/ Reference-DRR, Debit Request w/o Reference-DWR, Rush-RUS, Urgent-URG, Other-OTH, N/A-N/A, Hold-HLD, Dating-DTG.

Part Order Type entered or selected at dealership.

0..1Field sqdt:OrderTypeCodeType  
SpecialInstructions

Free form text identifying unique handling of order.

0..1Field udt:TextType  
OrderComments

Free form text of remarks regarding the order.

0..1Field udt:TextType  
PromotionCode

Code specifying a parts promotion.

0..1Field udt:CodeType  
PriorityString

0..1Field qdt:StringType  
ShipPriorityCode

Deprecated. Use: ShipmentCarrierTransportMethodTypeCode

0..1Field scl:ShipPriorityEnumeratedType  
AlternateShipPriorityCode

Deprecated. Use: ShipmentCarrierTransportMethodTypeCode

0..1Field scl:ShipPriorityEnumeratedType  
AllowBackOrderIndicator

Indicates that partial shipments are permitted. This is the default unless specified otherwise at the lineitem level. Navistar Use Case: True - This line may be backordered False - The line is cancelled if entire quantity cannot be shipped. This indicator applies only to this line. When the value is False, the line is cancelled unless it can be completely filled. When the value is True, the quantity specified is shipped in its entirety or the entire quantity is back-ordered unless Partial Shipping is Allowed. Default value - value from header

0..1Field udt:IndicatorType  
AllowCrossShipmentIndicator

Permission indicator for multiple shipment sources. Navistar Use Case: False - No sourcing True - Allow sourcing Default value - Use value from header

0..1Field udt:IndicatorType  
ShipWarehouseNumeric

Deprecated. Use: OriginatingWarehouse

0..1Field udt:NumericType  
PrintIndicator

Deprecated

0..1Field udt:IndicatorType  
FeedbackIndicator

Deprecated. Use:ShipTo

0..1Field udt:IndicatorType  
RepairOrderNumberString

Deprecated. Use:DocumentReferenceIdentificationGroup

0..1Field qdt:StringType  
OrderReferenceNumberString

Deprecated. Use:DocumentReferenceIdentificationGroup

0..1Field qdt:StringType  
ConsolidateIndicator

Indicates like order types should be consolidated to one invoice/shipment.

0..1Field udt:IndicatorType  
SequenceCode

A pre-defined sort sequence for order consolidation, i.e., sort by part order.

0..1Field udt:CodeType  
ShipmentCarrierCode

Deprecated. Use: ShipmentCarrierCompanyCode

0..1Field scl:ShipmentCarrierEnumeratedType  
AlternateShipmentCarrierCode

Deprecated. Use: ShipmentCarrierCompanyCode

0..1Field scl:ShipmentCarrierEnumeratedType  
TariffCodeIndicator

Indicator of tariff.

0..1Field udt:IndicatorType  
TariffCode

Code identifying the tariff associated with the order/shipment.

0..1Field udt:CodeType  
BillToParty

The party that is receiving the bill for the goods or services.

0..1ComponentPartyABIEType 
ShipToParty

The party receiving the goods or services.

0..1ComponentPartyABIEType 
SupplierParty

The supplying party

0..1ComponentPartyABIEType 
AlternateShipToParty

Deprecated. Use:ShipTo

2008 PO Profile Group found that there was no use case for an AlternateShipTo

0..1ComponentPartyABIEType 
OrderActionCode

Identifies the action to be applied to the entire order (e.g., Ship, Cancel, Upgrade, etc.)

0..1Field udt:CodeType  
Status

Deprecated: Use AcknowledgmentStatus. Renamed field to handle correct NDR rules. This is left in for compatibility reasons. It will be removed in the next major version of STAR.

0..*Field AcknowledgementStatusType  
SubtotalAmount

Total amount of line items extended. This is the economic value of the lineitem.

0..1Field udt:AmountType  
EstimatedFreightCostAmount

Is used to the describe the estimated cost of transporting the items or products being sold, produced or purchased. This amount is usually determined at the time the sales order is created and is quoted to the customer, before the actual shipping method, weight or number of units is known. This is also customarily known as a general Shipping and Handling charge.

0..1Field udt:AmountType  
HandlingAmount

The amount charged for the preparation of a shipment

0..1Field udt:AmountType  
TotalAmountLessTax

Total dollar amount of the order including freight and handling charge, but excluding taxes.

0..1Field udt:AmountType  
AlternateShipToIndicator

Indicates if the order can be shipped to the alternate address.

0..1Field udt:IndicatorType  
OrderState

The OrderState component represents the current and history states of the order. This component may occur many times reflecting the history of states.

0..*ComponentOrderStateType 
AllowBackOrderPartialShipCode

Identifies if the dealer is willing to accept backorders and partial shipments on the order.

0..1Field scl:AllowBackOrderPartialShipEnumeratedType  
RequestedShipDate

The date the dealer is requesting the supplier to ship the order. This could be sooner or later that the typical stock order shipping date. However, it is expected this field is intended to delay the shipment from the typical stock order processing to some later preferred date.

0..1Field udt:DateType  
ManufacturerOrderNumberString

Deprecated: Use DocumentIdentificationGroup.

0..1Field qdt:StringType  
DealerOrderNumberString

Deprecated: Use DocumentIdentificationGroup.

0..1Field qdt:StringType  
ChangeIndicator

Indicates whether a field or sub-component has changed. This may be used on a Change BOD to indicate that a change has been made on a previously submitted document. Used at the Header level, this would indicate a change specifically to the Header.

0..1Field udt:IndicatorType  
CrossShipmentRestrictionCode

Used to restrict the shipping options on the OEM to the Dealer when Cross Shipment is allowed.

0..*Field sqdt:CrossShipmentRestrictionCodeType  
PartsOrderReceivedDateTime

The date and time a parts order was received.

0..1Field udt:DateTimeType  
FOBTermsString

Transit Ownership terms

0..1Field qdt:StringType  
ShipmentCarrierDetail

The ShipmentCarrierDetail component is used to describe the shipment carrier to be used for a shipment and the method by which the shipment will be made.

0..*ComponentShipmentCarrierDetailType 
OrderDatePeriod

The OrderDatePeriod component is used to identify a date range of orders.

0..1ComponentPeriodABIEType 
OrderedByName

The name of the individual who created the order.

0..1Field udt:NameType  
AllowSubstitutionIndicator

Indicates if the dealer allows substituted part. Navistar: Use the header resident version of this field to set a default for the entire order. The line resident field has three states False, True, and omitted. If omitted, the default value from the header is used. If the header field is omitted, the value is True for ALLOWED. False - Not allowed True - Allowed

0..1Field udt:IndicatorType  
AllowSupersessionIndicator

Indicates if the dealer allows a superseded part. Navistar Use Case: Use the header resident version of this field to set a default for the entire order. The line resident field has three states False, True, and omitted. If omitted, the default value from the header is used. If the header field is omitted, the value is True for ALLOWED. False - Not allowed True - Allowed

0..1Field udt:IndicatorType  
AcknowledgementStatus

0..*ComponentAcknowledgementStatusType 
DocumentReferenceIdentificationGroup

A group of identifications that uniquely identifies this document

0..1ComponentDocumentReferenceIdentificationGroupType 
ProgramCode

Code issued by item manufacturer that indicates the rules and pricing used when selling direct to retailers instead of through OEMs.

0..1Field udt:CodeType  
DatasourceURICode

The a code that points to a datasource where the datasource value is stored.

0..1Field udt:CodeType  
FreeFormTextGroup

This component allows for the free form entry of notes and text descriptions. Detailed data should use one of the existing fields or submit a modification request back to STAR to capture the appropriate data.

0..1ComponentFreeFormTextGroupType 
BackOrderTypeCode

Indicates the type of back order. Should only be set if back orders are allowed.

0..1Field udt:CodeType  
Vehicle

Common vehicle component

0..1ComponentVehicleABIEType 
POHRequestedShipDateTime

datetime the dealer is requesting the supplier to ship the order. This could be sooner or later than the tyThepical stock order shipping date. However, it is expected this field is intended to delay the shipment from the typical stock order processing to some later preferred datetime.

0..1Field udt:DateTimeType  
POHPromisedShipDateTime

Indicates the datetime in which the order was promised to be shipped from the supplier to the dealer. This is the default unless specified otherwise at the lineitem level.

0..1Field udt:DateTimeType  
Price

Price information

0..*ComponentPriceABIEType 
ShippingCondition

Defines shipping conditions based on order type.

0..*ComponentPartsDeliveryDetailsShippingConditionType 

Sample XML

The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.

Example 7.2. PartsOrderHeader

<PartsOrderHeader>
     <DocumentDateTime>......</DocumentDateTime>     [0..1]
     <SecondaryPassword>......</SecondaryPassword>     [0..1]
     <SecondaryDealerNumberID>......</SecondaryDealerNumberID>     [0..1]
     <DocumentIdentificationGroup>......</DocumentIdentificationGroup>     [1..1]
     <TaxabilityIndicator>......</TaxabilityIndicator>     [0..1]
     <PromisedDeliveryDate>......</PromisedDeliveryDate>     [0..1]
     <PromisedShipDate>......</PromisedShipDate>     [0..1]
     <AcknowledgmentDetail>......</AcknowledgmentDetail>     [0..1]
     <PaymentTerms>......</PaymentTerms>     [0..1]
     <OrderTypeCode>......</OrderTypeCode>     [0..1]
     <SpecialInstructions>......</SpecialInstructions>     [0..1]
     <OrderComments>......</OrderComments>     [0..1]
     <PromotionCode>......</PromotionCode>     [0..1]
     <PriorityString>......</PriorityString>     [0..1]
     <ShipPriorityCode>......</ShipPriorityCode>     [0..1]
     <AlternateShipPriorityCode>......</AlternateShipPriorityCode>     [0..1]
     <AllowBackOrderIndicator>......</AllowBackOrderIndicator>     [0..1]
     <AllowCrossShipmentIndicator>......</AllowCrossShipmentIndicator>     [0..1]
     <ShipWarehouseNumeric>......</ShipWarehouseNumeric>     [0..1]
     <PrintIndicator>......</PrintIndicator>     [0..1]
     <FeedbackIndicator>......</FeedbackIndicator>     [0..1]
     <RepairOrderNumberString>......</RepairOrderNumberString>     [0..1]
     <OrderReferenceNumberString>......</OrderReferenceNumberString>     [0..1]
     <ConsolidateIndicator>......</ConsolidateIndicator>     [0..1]
     <SequenceCode>......</SequenceCode>     [0..1]
     <ShipmentCarrierCode>......</ShipmentCarrierCode>     [0..1]
     <AlternateShipmentCarrierCode>......</AlternateShipmentCarrierCode>     [0..1]
     <TariffCodeIndicator>......</TariffCodeIndicator>     [0..1]
     <TariffCode>......</TariffCode>     [0..1]
     <BillToParty>......</BillToParty>     [0..1]
     <ShipToParty>......</ShipToParty>     [0..1]
     <SupplierParty>......</SupplierParty>     [0..1]
     <AlternateShipToParty>......</AlternateShipToParty>     [0..1]
     <OrderActionCode>......</OrderActionCode>     [0..1]
     <Status>......</Status>     [0..*]
     <SubtotalAmount>......</SubtotalAmount>     [0..1]
     <EstimatedFreightCostAmount>......</EstimatedFreightCostAmount>     [0..1]
     <HandlingAmount>......</HandlingAmount>     [0..1]
     <TotalAmountLessTax>......</TotalAmountLessTax>     [0..1]
     <AlternateShipToIndicator>......</AlternateShipToIndicator>     [0..1]
     <OrderState>......</OrderState>     [0..*]
     <AllowBackOrderPartialShipCode>......</AllowBackOrderPartialShipCode>     [0..1]
     <RequestedShipDate>......</RequestedShipDate>     [0..1]
     <ManufacturerOrderNumberString>......</ManufacturerOrderNumberString>     [0..1]
     <DealerOrderNumberString>......</DealerOrderNumberString>     [0..1]
     <ChangeIndicator>......</ChangeIndicator>     [0..1]
     <CrossShipmentRestrictionCode>......</CrossShipmentRestrictionCode>     [0..*]
     <PartsOrderReceivedDateTime>......</PartsOrderReceivedDateTime>     [0..1]
     <FOBTermsString>......</FOBTermsString>     [0..1]
     <ShipmentCarrierDetail>......</ShipmentCarrierDetail>     [0..*]
     <OrderDatePeriod>......</OrderDatePeriod>     [0..1]
     <OrderedByName>......</OrderedByName>     [0..1]
     <AllowSubstitutionIndicator>......</AllowSubstitutionIndicator>     [0..1]
     <AllowSupersessionIndicator>......</AllowSupersessionIndicator>     [0..1]
     <AcknowledgementStatus>......</AcknowledgementStatus>     [0..*]
     <DocumentReferenceIdentificationGroup>......</DocumentReferenceIdentificationGroup>     [0..1]
     <ProgramCode>......</ProgramCode>     [0..1]
     <DatasourceURICode>......</DatasourceURICode>     [0..1]
     <FreeFormTextGroup>......</FreeFormTextGroup>     [0..1]
     <BackOrderTypeCode>......</BackOrderTypeCode>     [0..1]
     <Vehicle>......</Vehicle>     [0..1]
     <POHRequestedShipDateTime>......</POHRequestedShipDateTime>     [0..1]
     <POHPromisedShipDateTime>......</POHPromisedShipDateTime>     [0..1]
     <Price>......</Price>     [0..*]
     <ShippingCondition>......</ShippingCondition>     [0..*]
</PartsOrderHeader>