Uses the Component:PartsReturnHeaderType
Parts Return Header
Table 6.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..1 | Field | udt:DateTimeType | |
| SecondaryPassword |
Secondary password used to validate access to the dealer information | 0..1 | Field | udt:TextType | |
| SecondaryDealerNumberID |
Identifies secondary dealer number if different than primary "Dealer Number" | 0..1 | Field | udt:IdentifierType | |
| DocumentIdentificationGroup |
A group of identifications that uniquely identifies this document | 1..1 | Component | DocumentIdentificationGroupType | |
| ReturnAuthorizationNumberString |
Number of return authorized by manufacturer. | 0..1 | Field | qdt:StringType | |
| ReturnPartDealerComments | 0..1 | Field | udt:TextType | ||
| ReturnTypeString |
Designates the reason for the parts return. | 0..1 | Field | qdt:StringType | |
| ReturnAuthorizationShipDate |
OEM assigned date that return needs to be shipped to PDC. | 0..1 | Field | udt:DateType | |
| DeclarationStatement |
Declaration statement made by manufacturer. | 0..1 | Field | udt:TextType | |
| DealerShipmentNumberString | 0..1 | Field | qdt:StringType | ||
| ShippingPDC |
Parts Distribution Center (PDC) for shipment | 0..1 | Field | udt:TextType | |
| TotalHoldScrapValueAmount |
The total Hold and Scrap parts being returned equals the Total Value | 0..1 | Field | udt:AmountType | |
| TotalPartPiecesNumeric |
The total number of part pieces to be contained in the transaction. | 0..1 | Field | udt:NumericType | |
| TotalPartLinesNumeric |
The total number of unique parts [part number] contained in the transaction. | 0..1 | Field | udt:NumericType | |
| Status |
Deprecated: Use AcknowledgementStatus | 0..* | Field | AcknowledgementStatusType | |
| NormalBuybackLimitAmount |
Maximum normal re-purchase amount authorized by OEM for this order. | 0..1 | Field | udt:AmountType | |
| SupplementalBuybackLimitAmount |
Special re-purchase limit authorized by OEM for this order. | 0..1 | Field | udt:AmountType | |
| ScrapAtDealershipIndicator |
Indicates whether the part is scrapped at the dealership or returned to the depot. | 0..1 | Field | udt:IndicatorType | |
| CoreReturnIndicator |
Indicates whether the core part is scrapped at the dealership or returned to the depot. | 0..1 | Field | udt:IndicatorType | |
| WillCallIndicator |
Indicates whether the dealership delivers the part or if the part is shipped to the depot. | 0..1 | Field | udt:IndicatorType | |
| AcknowledgementStatus | 0..* | Component | AcknowledgementStatusType | ||
| ProgramCode |
Code issued by item manufacturer that indicates the rules and pricing used when selling direct to retailers instead of through OEMs. | 0..1 | Field | udt:CodeType | |
| DatasourceURICode |
The a code that points to a datasource where the datasource value is stored. | 0..1 | Field | udt:CodeType | |
| SequenceCode |
A pre-defined sort sequence for order consolidation, i.e., sort by part order. | 0..1 | Field | 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..1 | Component | FreeFormTextGroupType |
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 6.2. PartsReturnHeader
<PartsReturnHeader>
<DocumentDateTime>......</DocumentDateTime> [0..1]
<SecondaryPassword>......</SecondaryPassword> [0..1]
<SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1]
<DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1]
<ReturnAuthorizationNumberString>......</ReturnAuthorizationNumberString> [0..1]
<ReturnPartDealerComments>......</ReturnPartDealerComments> [0..1]
<ReturnTypeString>......</ReturnTypeString> [0..1]
<ReturnAuthorizationShipDate>......</ReturnAuthorizationShipDate> [0..1]
<DeclarationStatement>......</DeclarationStatement> [0..1]
<DealerShipmentNumberString>......</DealerShipmentNumberString> [0..1]
<ShippingPDC>......</ShippingPDC> [0..1]
<TotalHoldScrapValueAmount>......</TotalHoldScrapValueAmount> [0..1]
<TotalPartPiecesNumeric>......</TotalPartPiecesNumeric> [0..1]
<TotalPartLinesNumeric>......</TotalPartLinesNumeric> [0..1]
<Status>......</Status> [0..*]
<NormalBuybackLimitAmount>......</NormalBuybackLimitAmount> [0..1]
<SupplementalBuybackLimitAmount>......</SupplementalBuybackLimitAmount> [0..1]
<ScrapAtDealershipIndicator>......</ScrapAtDealershipIndicator> [0..1]
<CoreReturnIndicator>......</CoreReturnIndicator> [0..1]
<WillCallIndicator>......</WillCallIndicator> [0..1]
<AcknowledgementStatus>......</AcknowledgementStatus> [0..*]
<ProgramCode>......</ProgramCode> [0..1]
<DatasourceURICode>......</DatasourceURICode> [0..1]
<SequenceCode>......</SequenceCode> [0..1]
<FreeFormTextGroup>......</FreeFormTextGroup> [0..1]
</PartsReturnHeader>