Star Logo

Implementation Guideline

Show Vehicle Inventory
Repository Version Rev4.5.4












Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved












Show Vehicle Inventory

Table of Contents

top

Overview

This document is a guideline on how to use the Show Vehicle Inventory Business Object Document (BOD). Show Vehicle Inventory has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Show Vehicle Inventory process for individual consumers who service their automobiles through their OEM’s authorized Dealers. The focus is on Dealer and OEM interactions, not third party organizations. NOTE: Although this is the traditional use of the Show Vehicle Inventory, this BOD could be used to send Show Vehicle Inventory information between any two business parties.

The Show Vehicle Inventory Implementation Guidelines provide detailed information regarding the structure and meaning of the Show Vehicle Inventory BOD and corresponds directly to the Show Vehicle Inventory schema. In addition to structure and meaning, the Implementation Guidelines identify various business rules for specific fields/components that due to their nature, i.e. field interdependence, are not possible to express using schema. Please note that although these business rules are not included in the schema, they MUST be followed to be STAR Compliant. Therefore, the Show Vehicle Inventory Implementation Guidelines must be used in concert with the Show Vehicle Inventory schema during development and should NOT be considered a supplement or substitution to the schema. For more information regarding STAR XML Data Compliance, please review the STAR Data Compliance Guidelines document located on the STAR Web site.

For a copy of the corresponding Show Vehicle Inventory schema, please download the appropriate STAR schema repository from the XML portion of the STAR website (www.starstandard.org). Prior to downloading the schema, users are encouraged to download the STAR XML Reference/Implementation document also located on the XML portion of the STAR website. This document provides an overview of the STAR BOD development methodology, how to download and read STAR schema, and various frequently asked questions related to the implementation of STAR BODs.

STAR has followed the Open Application Group’s Business Object Document methodology to develop the Show Vehicle Inventory BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Show Vehicle Inventory BOD is unique to the Retail Automotive industry and is not an extension of any existing OAGIS BODs.

For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group’s Web site at www.openapplications.org.

top

Schema Field Usage

STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Show Vehicle Inventory except the Get verb. Please refer to each Noun/Verb combination within this document to understand the requirements for each specific BOD. Although the Noun will always have every field defined for the Noun in the schema, each Noun/Verb combination may not use all of the fields. If a field is not used by a BOD, it will be noted in the business rules.

top

Business Scenario

The Show Vehicle Inventory Binary Collaboration starts with the sending of Vehicle Inventory information from the OEM to the Dealer. This process occurs on demand as needed. Note: This scenario is an example of how the Vehicle Inventory BOD can be used. Implemenations may vary. Note only the PartyId to be retrieved needs to be filled in the SoldToParty component.

top

Relationship Diagram

The relationship diagram identifies all of the various components or building blocks of information used in the Show Vehicle Inventory BOD. This diagram visually depicts the relationships of the components using symbolic indentation and their occurrence in the BOD. Note: That this is an approximation of the Components, and may not reflect the exact implementation. Also, some fields are displayed in the diagram. This diagram should only be used as a starting point and not an absolute reference. Relationship Diagram for VehicleInventory

top

Schema Document Properties

Target Namespacehttp://www.starstandards.org/STAR
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
DocumentationThis schema is made available under an Eclipse Public Licenses 1.0. This license may be found in the STAR/License directory as well as the STAR BOD Guidelines.
More information at: http://www.starstandard.org/.

Declared Namespaces

PrefixNamespace
Default namespacehttp://www.starstandards.org/STAR
xmlhttp://www.w3.org/XML/1998/namespace
xsdhttp://www.w3.org/2001/XMLSchema

Schema Component Representation
<xsd:schema targetNamespace="http://www.starstandards.org/STAR" elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
top

Global Declarations

Element: ApplicationArea

NameApplicationArea
TypeApplicationArea
Nillableno
Abstractno
DocumentationProvides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
More information at: http://www.openapplications.org/oagis.

Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<ApplicationArea>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</ApplicationArea>
Schema Component Representation
<xsd:element name="ApplicationArea" type="ApplicationArea"/>
top

Element: Header

NameHeader
TypeVehicleInventoryHeader
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Header>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
<DocumentId> DocumentId </DocumentId> [0..1] ?
<InvoiceDate> InvoiceDate </InvoiceDate> [0..1] ?
<TransactionType> TransactionType </TransactionType> [0..1] ?
<SoldTo> SoldToParty </SoldTo> [0..1] ?
<ShipTo> ShipToParty </ShipTo> [0..1] ?
<Manufacturer> ManufacturerParty </Manufacturer> [0..1] ?
</Header>
Schema Component Representation
<xsd:element name="Header" type="VehicleInventoryHeader"/>
top

Element: Invoice

NameInvoice
TypeInvoice
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Invoice>
<InvoiceNumber> InvoiceNumber </InvoiceNumber> [0..1] ?
<InvoiceTotal> InvoiceTotal </InvoiceTotal> [0..1] ?
<LoadNumber> LoadNumber </LoadNumber> [0..1] ?
<BorderCrossingInd> BorderCrossingInd </BorderCrossingInd> [0..1] ?
<ETADate> ETADate </ETADate> [0..1] ?
<CarrierId> CarrierId </CarrierId> [0..1] ?
<Warehouse> Warehouse </Warehouse> [0..1] ?
<OrderDate> OrderDate </OrderDate> [0..1] ?
<Vehicle> InventoryVehicleExtended </Vehicle> [0..*] ?
<Tax> Tax </Tax> [0..*] ?
<DealerAssignedNumber> DealerAssignedNumber </DealerAssignedNumber> [0..1] ?
<StatusDate> StatusDate </StatusDate> [0..1] ?
<TargetBuildDate> TargetBuildDate </TargetBuildDate> [0..1] ?
<RejectCode> RejectCode </RejectCode> [0..1] ?
<OptionRestrictionStatements> OptionRestrictionStatements </OptionRestrictionStatements> [0..1] ?
<HoldCodeInd> HoldCodeInd </HoldCodeInd> [0..1] ?
<RejectResponsibilityCode> RejectResponsibilityCode </RejectResponsibilityCode> [0..1] ?
</Invoice>
Schema Component Representation
<xsd:element name="Invoice" type="Invoice"/>
top

Element: Show

  • This element can be used wherever the following element is referenced:

NameShow
TypeShow
Nillableno
Abstractno
DocumentationThe Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<Show
confirm="ConfirmType [0..1]"
>
<OriginalBODId> xsd:NMTOKEN </OriginalBODId> [0..1]
</Show>
Schema Component Representation
<xsd:element name="Show" type="Show" substitutionGroup="Verb"/>
top

Element: ShowVehicleInventory

NameShowVehicleInventory
TypeShowVehicleInventory
Nillableno
Abstractno

XML Instance Representation
<ShowVehicleInventory
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> ShowVehicleInventoryDataArea </DataArea> [1]
</ShowVehicleInventory>
Schema Component Representation
<xsd:element name="ShowVehicleInventory" type="ShowVehicleInventory"/>
top

Element: VehicleInventory

NameVehicleInventory
TypeVehicleInventory
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<VehicleInventory>
<Header> ... </Header> [1]
<Invoice> ... </Invoice> [0..*]
</VehicleInventory>
Schema Component Representation
<xsd:element name="VehicleInventory" type="VehicleInventory"/>
top

Element: Verb

  • The following elements can be used wherever this element is referenced:

NameVerb
TypeVerb
Nillableno
Abstractyes

XML Instance Representation
<Verb/>
Schema Component Representation
<xsd:element name="Verb" type="Verb" abstract="true"/>
top

Global Definitions

Components (Complex Type): Address

Super-types:AddressBase < Address (by extension)
Sub-types:

NameAddress
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
qualifier Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="Address">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:attribute name="qualifier" type="AddressQualifier"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AddressBase

Super-types:None
Sub-types:

NameAddressBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AddressBase">
<xsd:sequence>
<xsd:element name="AddressLine" type="AddressLine" maxOccurs="unbounded"/>
<xsd:element name="City" type="City"/>
<xsd:element name="County" type="County" minOccurs="0"/>
<xsd:element name="StateOrProvince" type="StateOrProvince"/>
<xsd:element name="Country" type="Country"/>
<xsd:element name="PostalCode" type="PostalCode"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): AlternatePartyId

Super-types:None
Sub-types:

NameAlternatePartyId
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AlternatePartyId">
<xsd:sequence>
<xsd:element name="Id" type="Id"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Amount

Super-types:xsd:decimal < Amount (by extension)
Sub-types:None

NameAmount
Abstractno
DocumentationBased on OAGI Amount. Simple content with the currency as an attrbute
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
currency Required 

XML Instance Representation
<...
currency="Currency [1]"
>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Amount">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal">
<xsd:attribute name="currency" type="Currency" use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ApplicationArea

Super-types:None
Sub-types:None

NameApplicationArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SenderIdentifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. Required 
CreationDateTimeis the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. Required
DateTime fields must be formatted as XML Schema Datetimes in UTC/GMT format without offsets. Example: 2003-11-05T13:15:30Z
 
SignatureIf the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs. Optional
Optional. "qualifyingAgency" attribute.
 
BODIdThe BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. Optional 
DestinationInformation related to the receiver of the BOD Required
See Destination Component.
 

XML Instance Representation
<...>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="ApplicationArea">
<xsd:sequence>
<xsd:element name="Sender" type="Sender"/>
<xsd:element name="CreationDateTime" type="DateTime"/>
<xsd:element name="Signature" type="Signature" minOccurs="0"/>
<xsd:element name="BODId" type="Code" minOccurs="0"/>
<xsd:element name="Destination" type="Destination"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): BrandedInfo

Super-types:None
Sub-types:None

NameBrandedInfo
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
BrandedTitleIndThis tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) Optional
Value: 1 - Yes. 0 - No
 
BrandedTitleDateBranding Date Optional
In YYYY-MM-DD format.
 
BrandingStateCodeBranding State Code Optional 
BrandingStateReferenceBranding State Reference Number Optional 
BrandingSourceBranding source √ƒ¬Ę¬€¬“ (i.e., source who says that the vehicle is branded) Optional 

XML Instance Representation
<...>
<BrandedTitleInd> BrandedTitleInd </BrandedTitleInd> [0..1] ?
<BrandedTitleDate> BrandedTitleDate </BrandedTitleDate> [0..1] ?
<BrandingStateCode> BrandingStateCode </BrandingStateCode> [0..1] ?
<BrandingStateReference> BrandingStateReference </BrandingStateReference> [0..1] ?
<BrandingSource> BrandingSource </BrandingSource> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="BrandedInfo">
<xsd:sequence>
<xsd:element name="BrandedTitleInd" type="BrandedTitleInd" minOccurs="0"/>
<xsd:element name="BrandedTitleDate" type="BrandedTitleDate" minOccurs="0"/>
<xsd:element name="BrandingStateCode" type="BrandingStateCode" minOccurs="0"/>
<xsd:element name="BrandingStateReference" type="BrandingStateReference" minOccurs="0"/>
<xsd:element name="BrandingSource" type="BrandingSource" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): BrandingStateCode

Super-types:xsd:string < StateOrProvince (by restriction) < BrandingStateCode (by extension)
Sub-types:None

NameBrandingStateCode
Abstractno
DocumentationBranding State Code
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="BrandingStateCode">
<xsd:simpleContent>
<xsd:extension base="StateOrProvince"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BusinessObjectDocument

Super-types:None
Sub-types:

NameBusinessObjectDocument
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
revisionThis should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. Optional 
releaseIndicates the OAGIS release that this BOD belongs. Optional 
environmentIndicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). Optional 
langIndicates the language that the contents of the BOD is in unless otherwise stated. Optional 
bodVersionDeprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. Optional 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. Required 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="BusinessObjectDocument">
<xsd:sequence>
<xsd:element ref="ApplicationArea"/>
</xsd:sequence>
<xsd:attribute name="revision" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="release" type="Text" use="optional" fixed="8.1-Lite"/>
<xsd:attribute name="environment" use="optional" default="Production">
<xsd:simpleType>
<xsd:restriction base="Text">
<xsd:enumeration value="Test"/>
<xsd:enumeration value="Production"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="lang" type="Language" use="optional"/>
<xsd:attribute name="bodVersion" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Components (Complex Type): CarrierId

Super-types:xsd:string < Id (by extension) < CarrierId (by extension)
Sub-types:None

NameCarrierId
Abstractno
DocumentationCarrier Code
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="CarrierId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CheckCode

Super-types:xsd:integer < Count (by extension) < CheckCode (by restriction)
Sub-types:None

NameCheckCode
Abstractno
DocumentationChecksum Ex: value for Model number and serial number combination
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="CheckCode">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CodeType

Super-types:xsd:string < CodeType (by extension)
Sub-types:None

NameCodeType
Abstractno
DocumentationUnique code name
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
listID Optional 
listName Optional 
listAgencyID Optional 
listAgencyName Optional 
listVersionID Optional 
listURI Optional 

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="CodeType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="listID" type="xsd:token" use="optional"/>
<xsd:attribute name="listName" type="xsd:string" use="optional"/>
<xsd:attribute name="listAgencyID" type="xsd:token" use="optional"/>
<xsd:attribute name="listAgencyName" type="xsd:string" use="optional"/>
<xsd:attribute name="listVersionID" type="xsd:token" use="optional"/>
<xsd:attribute name="listURI" type="xsd:anyURI" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ConfirmableVerb

Super-types:Verb < ConfirmableVerb (by extension)
Sub-types:

NameConfirmableVerb
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
confirm Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
/>
Schema Component Representation
<xsd:complexType name="ConfirmableVerb">
<xsd:complexContent>
<xsd:extension base="Verb">
<xsd:attribute name="confirm" type="ConfirmType"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ContactBase

Super-types:None
Sub-types:

NameContactBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ContactBase">
<xsd:sequence>
<xsd:element name="Telephone" type="IndividualPartyContactTelephoneNumber" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EMailAddress" type="IndividualPartyContactEMail" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Fax" type="IndividualPartyContactFax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PreferredContactMethod" type="PreferredContactMethod" minOccurs="0"/>
<xsd:element name="ContactTime" type="ContactTime" minOccurs="0"/>
<xsd:element name="PrimaryContactInd" type="PrimaryContactInd" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Count

Super-types:xsd:integer < Count (by extension)
Sub-types:None

NameCount
Abstractno
DocumentationSimple quantity type with no attributes
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:integer
</...>
Schema Component Representation
<xsd:complexType name="Count">
<xsd:simpleContent>
<xsd:extension base="xsd:integer"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DeliveryMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < DeliveryMileage (by extension)
Sub-types:None

NameDeliveryMileage
Abstractno
DocumentationOdometer reading of vehicle at time of delivery
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="DeliveryMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Description

Super-types:xsd:string < Description (by extension)
Sub-types:None

NameDescription
Abstractno
DocumentationDescription
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
languageThe ISO language code that the description is written. Optional 

XML Instance Representation
<...
language="Language [0..1] ?"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Description">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="language" type="Language" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Destination

Super-types:None
Sub-types:None

NameDestination
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DestinationNameCodeCode for destination of file (i.e.Short Manufacturer or DSP code) Optional
Must use a valid code from the ShortMfg/RSP list on http://www.starstandards.org
 
DestinationURIPhysical address of the destination Optional 
DestinationSoftwareCodeAdditional information about the destination application Optional 
DestinationSoftwareFor which software destination file is intended (may not be known). Optional 
DealerNumberTarget Dealer Code receiving information Optional 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountryTarget Dealer country location Optional 
PartyIdThe Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. Optional 
LocationIdThe Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. Optional 
ServiceIdThe Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<DestinationNameCode> ShortMfg </DestinationNameCode> [0..1] ?
<DestinationURI> URI </DestinationURI> [0..1] ?
<DestinationSoftwareCode> Text </DestinationSoftwareCode> [0..1] ?
<DestinationSoftware> Text </DestinationSoftware> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Destination">
<xsd:sequence>
<xsd:element name="DestinationNameCode" type="ShortMfg" minOccurs="0"/>
<xsd:element name="DestinationURI" type="URI" minOccurs="0"/>
<xsd:element name="DestinationSoftwareCode" type="Text" minOccurs="0"/>
<xsd:element name="DestinationSoftware" type="Text" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): DocumentId

Super-types:xsd:string < Id (by extension) < DocumentId (by extension)
Sub-types:None

NameDocumentId
Abstractno
DocumentationIs the identifier for the document.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DocumentId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DoorsQuantity

Super-types:xsd:integer < Count (by extension) < DoorsQuantity (by restriction)
Sub-types:None

NameDoorsQuantity
Abstractno
DocumentationNumber of doors on vehicle
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="DoorsQuantity">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ExpandedOption

Super-types:OptionBase < Option (by extension) < ExpandedOption (by extension)
Sub-types:None

NameExpandedOption
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 
OptionPricePrice of Vehicle Option Optional 
OptionSecurityCodeSecurity code to unlock option. (i.e, radio code)n Optional 
ManufacturerInstalledIndIndicates manufacturer-installed accessories Optional 
OptionCostActual Dealer cost of option Optional 
OptionMSRPOption MSRP Optional 
OptionOriginIdentifies the option installer Optional 
OptionSerialNumberSerial number of Option Optional 
ItemIdPart number identifier of Option Optional 
PartTypeSpecifies whether the parts are indicated by manufacturer part code or Part Number Optional 
OptionNotesFree form text related to option Optional 
DealerInstallationIndDealer installed accessories, before delivery of vehicle - Could be used for new or used vehicle, if applicable Optional 
MiscellaneousCodeMiscellaneous codes relating to vehicle (i.e., sales codes) Optional 
OptionPackageIdOption package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,OptPkg1; Item1,nocost,OptPkg1; Item2,nocost,Optpkg1; Item3,cost,nullOptPkg; OptPkg2,cost,Optpkg2; Item5,nocost,OptPkg2√ƒ¬Ę¬€√‚¬¶ Optional 
OptionSalesCodeFurther definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. Optional 
PortInstalledIndIndicates Port-installed accessories Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
<OptionPrice> OptionPrice </OptionPrice> [0..1] ?
<OptionSecurityCode> OptionSecurityCode </OptionSecurityCode> [0..1] ?
<ManufacturerInstalledInd> ManufacturerInstalledInd </ManufacturerInstalledInd> [0..1] ?
<OptionCost> OptionCost </OptionCost> [0..1] ?
<OptionMSRP> OptionMSRP </OptionMSRP> [0..1] ?
<OptionOrigin> OptionOrigin </OptionOrigin> [0..1] ?
<OptionSerialNumber> OptionSerialNumber </OptionSerialNumber> [0..1] ?
<ItemId> ItemId </ItemId> [0..1] ?
<PartType> PartType </PartType> [0..1] ?
<OptionNotes> OptionNotes </OptionNotes> [0..1] ?
<DealerInstallationInd> DealerInstallationInd </DealerInstallationInd> [0..1] ?
<MiscellaneousCode> MiscellaneousCode </MiscellaneousCode> [0..*] ?
<OptionPackageId> OptionPackageId </OptionPackageId> [0..1] ?
<OptionSalesCode> OptionSalesCode </OptionSalesCode> [0..1] ?
<PortInstalledInd> PortInstalledInd </PortInstalledInd> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ExpandedOption">
<xsd:complexContent>
<xsd:extension base="Option">
<xsd:sequence>
<xsd:element name="OptionSecurityCode" type="OptionSecurityCode" minOccurs="0"/>
<xsd:element name="ManufacturerInstalledInd" type="ManufacturerInstalledInd" minOccurs="0"/>
<xsd:element name="OptionCost" type="OptionCost" minOccurs="0"/>
<xsd:element name="OptionMSRP" type="OptionMSRP" minOccurs="0"/>
<xsd:element name="OptionOrigin" type="OptionOrigin" minOccurs="0"/>
<xsd:element name="OptionSerialNumber" type="OptionSerialNumber" minOccurs="0"/>
<xsd:element name="ItemId" type="ItemId" minOccurs="0"/>
<xsd:element name="PartType" type="PartType" minOccurs="0"/>
<xsd:element name="OptionNotes" type="OptionNotes" minOccurs="0"/>
<xsd:element name="DealerInstallationInd" type="DealerInstallationInd" minOccurs="0"/>
<xsd:element name="MiscellaneousCode" type="MiscellaneousCode" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="OptionPackageId" type="OptionPackageId" minOccurs="0"/>
<xsd:element name="OptionSalesCode" type="OptionSalesCode" minOccurs="0"/>
<xsd:element name="PortInstalledInd" type="PortInstalledInd" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ExpandedVehicle

Super-types:Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension)
Sub-types:

NameExpandedVehicle
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ModelManufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) Optional 
ModelYearVehicle designated model year Optional 
ModelDescriptionDescriptive vehicle model name Optional 
MakeVehicle make code - Usually available in the VIN number (use NCIC code). Optional 
SaleClassClass of Sale Optional 
ConditionCondition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown Optional 
CertifiedPreownedIndIdentifies as a certified Pre-Owned Vehicle Optional 
VehicleNoteAny vehicle related notes Optional 
VINFederally defined 17 position vehicle identification number Optional 
DeliveryMileageOdometer reading of vehicle at time of delivery Optional 
VehicleStockDealer assigned vehicle stock number Optional 
TrimCodeManufacturer assigned trim code Optional 
DoorsQuantityNumber of doors on vehicle Optional 
BodyStyleManufacturer-assigned vehicle body style Optional 
InteriorColorVehicle Interior Color(s) Optional 
ExteriorColorVehicle Exterior Color(s) Optional 
TransmissionTypeVehicle Transmission type Optional 
OdometerStatusStatus of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. Optional 
NonUSVehicleIndIndicates whether the vehicle was produced for the United States or not Optional 
VehicleDemoIndIndicates whether vehicle was ever a demo Optional 
LicenseNumberState License plate number of vehicle Optional 
BrandedInfoVehicle Branding Information Optional 
RestrictionIndIndication that vehicle has restrictions on its use Optional 
RestrictionDescriptionDescription of vehicle use restrictions Optional 
TelematicsServiceIndIndication whether Telematics Service Subscription is turned on Optional 
OptionVehicle Options Optional 
TransmissionCodeTransmission Serial Number Optional 
DeliveryDateThe date of original retail vehicle sale Optional 
EngineNumberSerial number of the engine if vehicle not made for US sale Optional 
IgnitionKeyNumberVehicle Ignition Key Number Optional 
AxleCodeThe code on the axle of the vehicle. Optional 
FleetAccountManufacturer defined fleet account number Optional 
FleetVehicleIdUniquely identifies the vehicle as part of a fleet company Optional 
FleetPurchaseOrderNumberFleet Purchase Order Number vehicle was purchased under Optional 
DoorKeyNumberDoor key number Optional 
VehicleWeightVehicle weight Optional 
ExteriorColorCodeVehicle exterior color code Optional 
InteriorColorCodeVehicle Interior color code Optional 

XML Instance Representation
<...>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ExpandedOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<FleetVehicleId> FleetVehicleId </FleetVehicleId> [0..1] ?
<FleetPurchaseOrderNumber> FleetPurchaseOrderNumber </FleetPurchaseOrderNumber> [0..1] ?
<DoorKeyNumber> DoorKeyNumber </DoorKeyNumber> [0..1] ?
<VehicleWeight> VehicleWeight </VehicleWeight> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..*] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="ExpandedVehicle">
<xsd:complexContent>
<xsd:extension base="VehicleBase">
<xsd:sequence>
<xsd:element name="Option" type="ExpandedOption" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="TransmissionCode" type="TransmissionCode" minOccurs="0"/>
<xsd:element name="DeliveryDate" type="DeliveryDate" minOccurs="0"/>
<xsd:element name="EngineNumber" type="EngineNumber" minOccurs="0"/>
<xsd:element name="IgnitionKeyNumber" type="IgnitionKeyNumber" minOccurs="0"/>
<xsd:element name="AxleCode" type="AxleCode" minOccurs="0"/>
<xsd:element name="FleetAccount" type="FleetAccount" minOccurs="0"/>
<xsd:element name="FleetVehicleId" type="FleetVehicleId" minOccurs="0"/>
<xsd:element name="FleetPurchaseOrderNumber" type="FleetPurchaseOrderNumber" minOccurs="0"/>
<xsd:element name="DoorKeyNumber" type="DoorKeyNumber" minOccurs="0"/>
<xsd:element name="VehicleWeight" type="VehicleWeight" minOccurs="0"/>
<xsd:element name="ExteriorColorCode" type="ExteriorColorCode" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="InteriorColorCode" type="InteriorColorCode" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): FleetVehicleId

Super-types:xsd:string < Id (by extension) < FleetVehicleId (by extension)
Sub-types:None

NameFleetVehicleId
Abstractno
DocumentationUniquely identifies the vehicle as part of a fleet company
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="FleetVehicleId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): HeaderBase

Super-types:None
Sub-types:

NameHeaderBase
Abstractno
DocumentationUsed on all STAR BODs
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentDateTimeIs the date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional
DateTime fields must be formatted as XML Schema DateTimes in UTC/GMT format without offsets. Example: 2003-11-05T13:15:30Z
 
SecondaryPasswordSecondary password used to validate access to the dealer information Optional
(INACTIVE)
 
SecondaryDealerNumberIdentifies secondary dealer number if different than primary "Dealer Number" Optional
(INACTIVE)
 

XML Instance Representation
<...>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="HeaderBase">
<xsd:sequence>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
<xsd:element name="SecondaryPassword" type="SecondaryPassword" minOccurs="0"/>
<xsd:element name="SecondaryDealerNumber" type="SecondaryDealerNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Id

Super-types:xsd:string < Id (by extension)
Sub-types:None

NameId
Abstractno
DocumentationParty Identification number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Id">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerParty

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension)
Sub-types:

NameIndividualOwnerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerParty">
<xsd:complexContent>
<xsd:extension base="IndividualPartyBase">
<xsd:sequence>
<xsd:element name="Contact" type="IndividualPartyContact" minOccurs="0"/>
<xsd:element name="RelationshipCode" type="RelationshipCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerPartyExtended

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartyExtended (by extension)
Sub-types:None

NameIndividualOwnerPartyExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DemographicsIndividual party demographic information Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional
Values: 1 - Can send mail to. 0 - Can not send mail to.
 
PrimaryDriverIndIdentifies customer as primary driver Optional
Values: 1 - Primary Driver, 0 - Not primary driver.
 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional
Service action related to this RO (Ex: Drop-Off, Pick-Up, etc)
 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<Demographics> MinimalDemographics </Demographics> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerPartyExtended">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerParty">
<xsd:sequence>
<xsd:element name="Demographics" type="MinimalDemographics" minOccurs="0"/>
<xsd:element name="MarketingMailInd" type="MarketingMailInd" minOccurs="0"/>
<xsd:element name="PrimaryDriverInd" type="PrimaryDriverInd" minOccurs="0"/>
<xsd:element name="DriverAction" type="DriverAction" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAddress

Super-types:AddressBase < Address (by extension) < IndividualPartyAddress (by extension)
Sub-types:None

NameIndividualPartyAddress
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAddress">
<xsd:complexContent>
<xsd:extension base="Address">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAlternatePartyId

Super-types:AlternatePartyId < IndividualPartyAlternatePartyId (by extension)
Sub-types:None

NameIndividualPartyAlternatePartyId
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 
AssigningPartyIdAgency or entity that validates the Party Id Required 
IssuingStateIndicates that State where the license was issued. Optional 
ExpirationDateExpiration date of the alternate party id (e.g., Driver's License expiration date). Optional 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
<AssigningPartyId> AssigningPartyId </AssigningPartyId> [1] ?
<IssuingState> IssuingState </IssuingState> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAlternatePartyId">
<xsd:complexContent>
<xsd:extension base="AlternatePartyId">
<xsd:sequence>
<xsd:element name="AssigningPartyId" type="AssigningPartyId"/>
<xsd:element name="IssuingState" type="IssuingState" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyBase

Super-types:PartyBase < IndividualPartyBase (by extension)
Sub-types:

NameIndividualPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="AlternatePartyIds" type="IndividualPartyAlternatePartyId" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
<xsd:element name="Address" type="IndividualPartyAddress" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContact

Super-types:ContactBase < IndividualPartyContact (by extension)
Sub-types:None

NameIndividualPartyContact
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional 
PersonNameContact name Optional 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContact">
<xsd:complexContent>
<xsd:extension base="ContactBase">
<xsd:sequence>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactEMail

Super-types:xsd:string < IndividualPartyContactEMail (by extension)
Sub-types:None

NameIndividualPartyContactEMail
Abstractno
DocumentationIndividual Party email
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactEMail">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactFax

Super-types:xsd:string < IndividualPartyContactFax (by extension)
Sub-types:None

NameIndividualPartyContactFax
Abstractno
DocumentationIndividual Party Fax number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactFax">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactTelephoneNumber

Super-types:xsd:string < IndividualPartyContactTelephoneNumber (by extension)
Sub-types:None

NameIndividualPartyContactTelephoneNumber
Abstractno
DocumentationIndividualParty telephone number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 
exten Required 

XML Instance Representation
<...

exten="Note [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactTelephoneNumber">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="ContactTelephoneNumberDescription"/>
<xsd:attribute name="exten" type="Note"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyPersonName

Super-types:None
Sub-types:None

NameIndividualPartyPersonName
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SalutationTitle or greeting of business party Optional 
GivenNameFirst Name of business party Required 
MiddleNameMiddle Initial of business party Optional 
FamilyNameLast Name of business party Required 
SuffixBusiness Party name suffix designation if individual Ex: Sr, Jr, III, etc. Optional 
FormattedNameFull Name of business party. Format for name should be "First Last" with no commas between first and last name Optional
Format should be 'First Last' with no commas between first and last name.
 
SortNameIndex name used as a sort for report purposes Optional 

XML Instance Representation
<...>
<Salutation> Salutation </Salutation> [0..1] ?
<GivenName> GivenName </GivenName> [1] ?
<MiddleName> MiddleName </MiddleName> [0..1] ?
<FamilyName> FamilyName </FamilyName> [1] ?
<Suffix> Suffix </Suffix> [0..1] ?
<FormattedName> FormattedName </FormattedName> [0..1] ?
<SortName> SortName </SortName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyPersonName">
<xsd:sequence>
<xsd:element name="Salutation" type="Salutation" minOccurs="0"/>
<xsd:element name="GivenName" type="GivenName"/>
<xsd:element name="MiddleName" type="MiddleName" minOccurs="0"/>
<xsd:element name="FamilyName" type="FamilyName"/>
<xsd:element name="Suffix" type="Suffix" minOccurs="0"/>
<xsd:element name="FormattedName" type="FormattedName" minOccurs="0"/>
<xsd:element name="SortName" type="SortName" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): InventoryVehicle

Super-types:Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) < InventoryVehicle (by extension)
Sub-types:

NameInventoryVehicle
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ModelManufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) Optional 
ModelYearVehicle designated model year Optional 
ModelDescriptionDescriptive vehicle model name Optional 
MakeVehicle make code - Usually available in the VIN number (use NCIC code). Optional 
SaleClassClass of Sale Optional 
ConditionCondition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown Optional 
CertifiedPreownedIndIdentifies as a certified Pre-Owned Vehicle Optional 
VehicleNoteAny vehicle related notes Optional 
VINFederally defined 17 position vehicle identification number Optional 
DeliveryMileageOdometer reading of vehicle at time of delivery Optional 
VehicleStockDealer assigned vehicle stock number Optional 
TrimCodeManufacturer assigned trim code Optional 
DoorsQuantityNumber of doors on vehicle Optional 
BodyStyleManufacturer-assigned vehicle body style Optional 
InteriorColorVehicle Interior Color(s) Optional 
ExteriorColorVehicle Exterior Color(s) Optional 
TransmissionTypeVehicle Transmission type Optional 
OdometerStatusStatus of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. Optional 
NonUSVehicleIndIndicates whether the vehicle was produced for the United States or not Optional 
VehicleDemoIndIndicates whether vehicle was ever a demo Optional 
LicenseNumberState License plate number of vehicle Optional 
BrandedInfoVehicle Branding Information Optional 
RestrictionIndIndication that vehicle has restrictions on its use Optional 
RestrictionDescriptionDescription of vehicle use restrictions Optional 
TelematicsServiceIndIndication whether Telematics Service Subscription is turned on Optional 
OptionVehicle Options Optional 
TransmissionCodeTransmission Serial Number Optional 
DeliveryDateThe date of original retail vehicle sale Optional 
EngineNumberSerial number of the engine if vehicle not made for US sale Optional 
IgnitionKeyNumberVehicle Ignition Key Number Optional 
AxleCodeThe code on the axle of the vehicle. Optional 
FleetAccountManufacturer defined fleet account number Optional 
FleetVehicleIdUniquely identifies the vehicle as part of a fleet company Optional 
FleetPurchaseOrderNumberFleet Purchase Order Number vehicle was purchased under Optional 
DoorKeyNumberDoor key number Optional 
VehicleWeightVehicle weight Optional 
ExteriorColorCodeVehicle exterior color code Optional 
InteriorColorCodeVehicle Interior color code Optional 
VehicleStatusVehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. Optional 
VehicleShipDateDate shipped from warehouse or distribution center Optional
In YYYY-MM-DD format.
 
VehicleOrderTypeIdentifies vehicle Invoice order type Optional 
VehicleAllocatedDateDate vehicle was allocated and/or a delivery work order was cut Optional
In YYYY-MM-DD format.
 
VehicleLocationIndicates the physical location of the vehicle Optional 
VehicleAcquisitionDateActual date vehicle was acquired by Dealership Optional
In YYYY-MM-DD format.
 
VehiclePricingVehicle Pricing Optional
Value: MSRP, HoldBack, Destination / Handling, Group Fund Price, Wholesale Price, Actual Cash Value, Total Option Price, Total Option Cost
 
ModelGroupGrouping of similar models for order management purposes Optional 
IndividualOwnerIndividual who owns the vehicle Optional 
OrganizationalOwnerOrganization that owns the vehicle Optional 
TaxVehicle Tax Optional
Value: Amount
 
SoldToBusiness party who purchased the vehicle(s) Optional 
ShipToBusiness party who the vehicle(s) was shipped to Optional 
VehicleOrderNumberVehicle Order Number (VON) Optional 

XML Instance Representation
<...>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ExpandedOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<FleetVehicleId> FleetVehicleId </FleetVehicleId> [0..1] ?
<FleetPurchaseOrderNumber> FleetPurchaseOrderNumber </FleetPurchaseOrderNumber> [0..1] ?
<DoorKeyNumber> DoorKeyNumber </DoorKeyNumber> [0..1] ?
<VehicleWeight> VehicleWeight </VehicleWeight> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..*] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..*] ?
<VehicleStatus> VehicleStatus </VehicleStatus> [0..1] ?
<VehicleShipDate> VehicleShipDate </VehicleShipDate> [0..1] ?
<VehicleOrderType> VehicleOrderType </VehicleOrderType> [0..1] ?
<VehicleAllocatedDate> VehicleAllocatedDate </VehicleAllocatedDate> [0..1] ?
<VehicleLocation> VehicleLocation </VehicleLocation> [0..1] ?
<VehicleAcquisitionDate> VehicleAcquisitionDate </VehicleAcquisitionDate> [0..1] ?
<VehiclePricing> VehiclePricing </VehiclePricing> [0..*] ?
<ModelGroup> ModelGroup </ModelGroup> [0..1] ?
<IndividualOwner> IndividualOwnerPartyExtended </IndividualOwner> [0..1] ?
<OrganizationalOwner> OrganizationalOwnerPartyExtended </OrganizationalOwner> [0..1] ?
<Tax> Tax </Tax> [0..*] ?
<SoldTo> SoldToParty </SoldTo> [0..1] ?
<ShipTo> ShipToParty </ShipTo> [0..1] ?
<VehicleOrderNumber> VehicleOrderNumber </VehicleOrderNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="InventoryVehicle">
<xsd:complexContent>
<xsd:extension base="ExpandedVehicle">
<xsd:sequence>
<xsd:element name="VehicleStatus" type="VehicleStatus" minOccurs="0"/>
<xsd:element name="VehicleShipDate" type="VehicleShipDate" minOccurs="0"/>
<xsd:element name="VehicleOrderType" type="VehicleOrderType" minOccurs="0"/>
<xsd:element name="VehicleAllocatedDate" type="VehicleAllocatedDate" minOccurs="0"/>
<xsd:element name="VehicleLocation" type="VehicleLocation" minOccurs="0"/>
<xsd:element name="VehicleAcquisitionDate" type="VehicleAcquisitionDate" minOccurs="0"/>
<xsd:element name="VehiclePricing" type="VehiclePricing" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="ModelGroup" type="ModelGroup" minOccurs="0"/>
<xsd:element name="IndividualOwner" type="IndividualOwnerPartyExtended" minOccurs="0"/>
<xsd:element name="OrganizationalOwner" type="OrganizationalOwnerPartyExtended" minOccurs="0"/>
<xsd:element name="Tax" type="Tax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="SoldTo" type="SoldToParty" minOccurs="0"/>
<xsd:element name="ShipTo" type="ShipToParty" minOccurs="0"/>
<xsd:element name="VehicleOrderNumber" type="VehicleOrderNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): InventoryVehicleExtended

Super-types:Vehicle < VehicleBase (by extension) < ExpandedVehicle (by extension) < InventoryVehicle (by extension) < InventoryVehicleExtended (by extension)
Sub-types:None

NameInventoryVehicleExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ModelManufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) Optional 
ModelYearVehicle designated model year Optional 
ModelDescriptionDescriptive vehicle model name Optional 
MakeVehicle make code - Usually available in the VIN number (use NCIC code). Optional 
SaleClassClass of Sale Optional 
ConditionCondition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown Optional 
CertifiedPreownedIndIdentifies as a certified Pre-Owned Vehicle Optional 
VehicleNoteAny vehicle related notes Optional 
VINFederally defined 17 position vehicle identification number Optional 
DeliveryMileageOdometer reading of vehicle at time of delivery Optional 
VehicleStockDealer assigned vehicle stock number Optional 
TrimCodeManufacturer assigned trim code Optional 
DoorsQuantityNumber of doors on vehicle Optional 
BodyStyleManufacturer-assigned vehicle body style Optional 
InteriorColorVehicle Interior Color(s) Optional 
ExteriorColorVehicle Exterior Color(s) Optional 
TransmissionTypeVehicle Transmission type Optional 
OdometerStatusStatus of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. Optional 
NonUSVehicleIndIndicates whether the vehicle was produced for the United States or not Optional 
VehicleDemoIndIndicates whether vehicle was ever a demo Optional 
LicenseNumberState License plate number of vehicle Optional 
BrandedInfoVehicle Branding Information Optional 
RestrictionIndIndication that vehicle has restrictions on its use Optional 
RestrictionDescriptionDescription of vehicle use restrictions Optional 
TelematicsServiceIndIndication whether Telematics Service Subscription is turned on Optional 
OptionVehicle Options Optional 
TransmissionCodeTransmission Serial Number Optional 
DeliveryDateThe date of original retail vehicle sale Optional 
EngineNumberSerial number of the engine if vehicle not made for US sale Optional 
IgnitionKeyNumberVehicle Ignition Key Number Optional 
AxleCodeThe code on the axle of the vehicle. Optional 
FleetAccountManufacturer defined fleet account number Optional 
FleetVehicleIdUniquely identifies the vehicle as part of a fleet company Optional 
FleetPurchaseOrderNumberFleet Purchase Order Number vehicle was purchased under Optional 
DoorKeyNumberDoor key number Optional 
VehicleWeightVehicle weight Optional 
ExteriorColorCodeVehicle exterior color code Optional 
InteriorColorCodeVehicle Interior color code Optional 
VehicleStatusVehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. Optional 
VehicleShipDateDate shipped from warehouse or distribution center Optional
In YYYY-MM-DD format.
 
VehicleOrderTypeIdentifies vehicle Invoice order type Optional 
VehicleAllocatedDateDate vehicle was allocated and/or a delivery work order was cut Optional
In YYYY-MM-DD format.
 
VehicleLocationIndicates the physical location of the vehicle Optional 
VehicleAcquisitionDateActual date vehicle was acquired by Dealership Optional
In YYYY-MM-DD format.
 
VehiclePricingVehicle Pricing Optional
Value: MSRP, HoldBack, Destination / Handling, Group Fund Price, Wholesale Price, Actual Cash Value, Total Option Price, Total Option Cost
 
ModelGroupGrouping of similar models for order management purposes Optional 
IndividualOwnerIndividual who owns the vehicle Optional 
OrganizationalOwnerOrganization that owns the vehicle Optional 
TaxVehicle Tax Optional
Value: Amount
 
SoldToBusiness party who purchased the vehicle(s) Optional 
ShipToBusiness party who the vehicle(s) was shipped to Optional 
VehicleOrderNumberVehicle Order Number (VON) Optional 
ActivityStatusActivity status of vehicle while being manufactured or in transit Optional 
CheckCodeChecksum value for Model number and Serial number combination Optional 
RegulatoryRequirementsDescribes the regulatory requirements associated with the vehicle, such as customs or local government requirements Optional 

XML Instance Representation
<...>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ExpandedOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<FleetAccount> FleetAccount </FleetAccount> [0..1] ?
<FleetVehicleId> FleetVehicleId </FleetVehicleId> [0..1] ?
<FleetPurchaseOrderNumber> FleetPurchaseOrderNumber </FleetPurchaseOrderNumber> [0..1] ?
<DoorKeyNumber> DoorKeyNumber </DoorKeyNumber> [0..1] ?
<VehicleWeight> VehicleWeight </VehicleWeight> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..*] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..*] ?
<VehicleStatus> VehicleStatus </VehicleStatus> [0..1] ?
<VehicleShipDate> VehicleShipDate </VehicleShipDate> [0..1] ?
<VehicleOrderType> VehicleOrderType </VehicleOrderType> [0..1] ?
<VehicleAllocatedDate> VehicleAllocatedDate </VehicleAllocatedDate> [0..1] ?
<VehicleLocation> VehicleLocation </VehicleLocation> [0..1] ?
<VehicleAcquisitionDate> VehicleAcquisitionDate </VehicleAcquisitionDate> [0..1] ?
<VehiclePricing> VehiclePricing </VehiclePricing> [0..*] ?
<ModelGroup> ModelGroup </ModelGroup> [0..1] ?
<IndividualOwner> IndividualOwnerPartyExtended </IndividualOwner> [0..1] ?
<OrganizationalOwner> OrganizationalOwnerPartyExtended </OrganizationalOwner> [0..1] ?
<Tax> Tax </Tax> [0..*] ?
<SoldTo> SoldToParty </SoldTo> [0..1] ?
<ShipTo> ShipToParty </ShipTo> [0..1] ?
<VehicleOrderNumber> VehicleOrderNumber </VehicleOrderNumber> [0..1] ?
<ActivityStatus> ActivityStatus </ActivityStatus> [0..1] ?
<CheckCode> CheckCode </CheckCode> [0..1] ?
<RegulatoryRequirements> RegulatoryRequirements </RegulatoryRequirements> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="InventoryVehicleExtended">
<xsd:complexContent>
<xsd:extension base="InventoryVehicle">
<xsd:sequence>
<xsd:element name="ActivityStatus" type="ActivityStatus" minOccurs="0"/>
<xsd:element name="CheckCode" type="CheckCode" minOccurs="0"/>
<xsd:element name="RegulatoryRequirements" type="RegulatoryRequirements" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): Invoice

Super-types:None
Sub-types:None

NameInvoice
Abstractno
Documentation.
More information at: http://www.starstandards.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
InvoiceNumberManufacturer-assigned Invoice Number associated with the vehicle Optional 
InvoiceTotalGrand total for Vehicle Inventory Optional 
LoadNumberShipment carrier-assigned load number Optional 
BorderCrossingIndBorder crossing Indicator Optional 
ETADateVehicle estimated time of arrival at Ship To dealer Optional
In YYYY-MM-DD format
 
CarrierIdVehicle Shipment Carrier (Name or Code) Optional 
WarehouseWarehouse or Distribution Center vehicle shipped from Optional 
OrderDateDate vehicle order originally placed with manufacturer Optional
In YYYY-MM-DD format.
 
VehicleVehicle(s) covered by Inventory Optional 
TaxInvoice taxes Optional
Values: Amount, Weight
 
DealerAssignedNumberThe number given to an order by a dealer Optional 
StatusDateThe date the current status was recorded Optional 
TargetBuildDateThe date the OEM expects to build the vehicle Optional 
RejectCodeA code representing the reject status of an order Optional 
OptionRestrictionStatementsInformation about option restrictions on the vehicle. Ex: Sun Roof on Hold Optional 
HoldCodeIndRepresenting the hold status of an order Optional 
RejectResponsibilityCodeA code indicating who has action to take to address a reject Optional 

XML Instance Representation
<...>
<InvoiceNumber> InvoiceNumber </InvoiceNumber> [0..1] ?
<InvoiceTotal> InvoiceTotal </InvoiceTotal> [0..1] ?
<LoadNumber> LoadNumber </LoadNumber> [0..1] ?
<BorderCrossingInd> BorderCrossingInd </BorderCrossingInd> [0..1] ?
<ETADate> ETADate </ETADate> [0..1] ?
<CarrierId> CarrierId </CarrierId> [0..1] ?
<Warehouse> Warehouse </Warehouse> [0..1] ?
<OrderDate> OrderDate </OrderDate> [0..1] ?
<Vehicle> InventoryVehicleExtended </Vehicle> [0..*] ?
<Tax> Tax </Tax> [0..*] ?
<DealerAssignedNumber> DealerAssignedNumber </DealerAssignedNumber> [0..1] ?
<StatusDate> StatusDate </StatusDate> [0..1] ?
<TargetBuildDate> TargetBuildDate </TargetBuildDate> [0..1] ?
<RejectCode> RejectCode </RejectCode> [0..1] ?
<OptionRestrictionStatements> OptionRestrictionStatements </OptionRestrictionStatements> [0..1] ?
<HoldCodeInd> HoldCodeInd </HoldCodeInd> [0..1] ?
<RejectResponsibilityCode> RejectResponsibilityCode </RejectResponsibilityCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Invoice">
<xsd:sequence>
<xsd:element name="InvoiceNumber" type="InvoiceNumber" minOccurs="0"/>
<xsd:element name="InvoiceTotal" type="InvoiceTotal" minOccurs="0"/>
<xsd:element name="LoadNumber" type="LoadNumber" minOccurs="0"/>
<xsd:element name="BorderCrossingInd" type="BorderCrossingInd" minOccurs="0"/>
<xsd:element name="ETADate" type="ETADate" minOccurs="0"/>
<xsd:element name="CarrierId" type="CarrierId" minOccurs="0"/>
<xsd:element name="Warehouse" type="Warehouse" minOccurs="0"/>
<xsd:element name="OrderDate" type="OrderDate" minOccurs="0"/>
<xsd:element name="Vehicle" type="InventoryVehicleExtended" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Tax" type="Tax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="DealerAssignedNumber" type="DealerAssignedNumber" minOccurs="0"/>
<xsd:element name="StatusDate" type="StatusDate" minOccurs="0"/>
<xsd:element name="TargetBuildDate" type="TargetBuildDate" minOccurs="0"/>
<xsd:element name="RejectCode" type="RejectCode" minOccurs="0"/>
<xsd:element name="OptionRestrictionStatements" type="OptionRestrictionStatements" minOccurs="0"/>
<xsd:element name="HoldCodeInd" type="HoldCodeInd" minOccurs="0"/>
<xsd:element name="RejectResponsibilityCode" type="RejectResponsibilityCode" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): InvoiceTotal

Super-types:xsd:decimal < Amount (by extension) < InvoiceTotal (by extension)
Sub-types:None

NameInvoiceTotal
Abstractno
DocumentationInvoice Total
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="InvoiceTotal">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ItemId

Super-types:xsd:string < Id (by extension) < ItemId (by extension)
Sub-types:None

NameItemId
Abstractno
DocumentationItem part number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="ItemId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LocationId

Super-types:xsd:string < Id (by extension) < LocationId (by extension)
Sub-types:None

NameLocationId
Abstractno
DocumentationCode identifying a physical location
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="LocationId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ManufacturerParty

Super-types:PartyBase < ManufacturerParty (by extension)
Sub-types:None

NameManufacturerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
NameName of manufacturer or distributor Optional 
AddressOrganizational Party address Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<Name> Name </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ManufacturerParty">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="Name" type="Name" minOccurs="0"/>
<xsd:element name="Address" type="OrganizationAddress" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): Measurement

Super-types:xsd:decimal < Measurement (by extension)
Sub-types:None

NameMeasurement
Abstractno
DocumentationDecimal measurement
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Measurement">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Mileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension)
Sub-types:None

NameMileage
Abstractno
DocumentationMileage definition
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
uom Optional 

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="Mileage">
<xsd:simpleContent>
<xsd:extension base="Count">
<xsd:attribute name="uom" type="MileageMeasure" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): MinimalDemographics

Super-types:None
Sub-types:None

NameMinimalDemographics
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
GenderGender of party Optional 
LanguageBusiness party native language Optional 
BirthDateBirth date of party Optional 

XML Instance Representation
<...>
<Gender> Gender </Gender> [0..1] ?
<Language> Language </Language> [0..1] ?
<BirthDate> BirthDate </BirthDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="MinimalDemographics">
<xsd:sequence>
<xsd:element name="Gender" type="Gender" minOccurs="0"/>
<xsd:element name="Language" type="Language" minOccurs="0"/>
<xsd:element name="BirthDate" type="BirthDate" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ModelGroup

Super-types:xsd:string < Description (by extension) < ModelGroup (by extension)
Sub-types:None

NameModelGroup
Abstractno
DocumentationGrouping of similar models for order management purposes
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ModelGroup">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): NonTaxableAmount

Super-types:xsd:decimal < Amount (by extension) < NonTaxableAmount (by extension)
Sub-types:None

NameNonTaxableAmount
Abstractno
DocumentationTotal non-taxable price.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="NonTaxableAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Option

Super-types:OptionBase < Option (by extension)
Sub-types:

NameOption
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 
OptionPricePrice of Vehicle Option Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
<OptionPrice> OptionPrice </OptionPrice> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Option">
<xsd:complexContent>
<xsd:extension base="OptionBase">
<xsd:sequence>
<xsd:element name="OptionPrice" type="OptionPrice" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OptionBase

Super-types:None
Sub-types:

NameOptionBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OptionBase">
<xsd:sequence>
<xsd:element name="OptionType" type="OptionType" minOccurs="0"/>
<xsd:element name="OptionName" type="OptionName" minOccurs="0"/>
<xsd:element name="OptionStockNumber" type="OptionStockNumber" minOccurs="0"/>
<xsd:element name="Manufacturer" type="Manufacturer" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OptionCost

Super-types:xsd:decimal < Amount (by extension) < OptionCost (by extension)
Sub-types:None

NameOptionCost
Abstractno
DocumentationActual Dealer cost of option
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionCost">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionMSRP

Super-types:xsd:decimal < Amount (by extension) < OptionMSRP (by extension)
Sub-types:None

NameOptionMSRP
Abstractno
DocumentationOption MSRP
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionMSRP">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionPackageId

Super-types:xsd:string < Id (by extension) < OptionPackageId (by extension)
Sub-types:None

NameOptionPackageId
Abstractno
DocumentationOption package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="OptionPackageId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionPrice

Super-types:xsd:decimal < Amount (by extension) < OptionPrice (by extension)
Sub-types:None

NameOptionPrice
Abstractno
DocumentationPrice of Vehicle Option
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionPrice">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionRestrictionStatements

Super-types:xsd:string < Description (by extension) < OptionRestrictionStatements (by extension)
Sub-types:None

NameOptionRestrictionStatements
Abstractno
DocumentationInformation about option restrictions on the vehicle
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionRestrictionStatements">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionType

Super-types:xsd:string < CodeType (by extension) < OptionType (by extension)
Sub-types:None

NameOptionType
Abstractno
DocumentationOption Type from an OEM or other sources list of codes.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionType">
<xsd:simpleContent>
<xsd:extension base="CodeType"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationAddress

Super-types:AddressBase < OrganizationAddress (by extension)
Sub-types:None

NameOrganizationAddress
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationAddress">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalOwnerParty

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension)
Sub-types:

NameOrganizationalOwnerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
<Contact> OrganizationContactExtended </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalOwnerParty">
<xsd:complexContent>
<xsd:extension base="OrganizationPartyBase">
<xsd:sequence>
<xsd:element name="Contact" type="OrganizationContactExtended" minOccurs="0"/>
<xsd:element name="RelationshipCode" type="RelationshipCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalOwnerPartyExtended

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension)
Sub-types:None

NameOrganizationalOwnerPartyExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
<Contact> OrganizationContactExtended </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalOwnerPartyExtended">
<xsd:complexContent>
<xsd:extension base="OrganizationalOwnerParty">
<xsd:sequence>
<xsd:element name="MarketingMailInd" type="MarketingMailInd" minOccurs="0"/>
<xsd:element name="PrimaryDriverInd" type="PrimaryDriverInd" minOccurs="0"/>
<xsd:element name="DriverAction" type="DriverAction" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalPartyAlternatePartyId

Super-types:AlternatePartyId < OrganizationalPartyAlternatePartyId (by extension)
Sub-types:None

NameOrganizationalPartyAlternatePartyId
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 
AssigningPartyIdAgency or entity that validates the Party Id Required 
IssuingStateIndicates that State where the license was issued. Optional 
ExpirationDateExpiration date of the alternate party id (e.g., Driver's License expiration date). Optional 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
<AssigningPartyId> AssigningOrganizationPartyId </AssigningPartyId> [1] ?
<IssuingState> IssuingState </IssuingState> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalPartyAlternatePartyId">
<xsd:complexContent>
<xsd:extension base="AlternatePartyId">
<xsd:sequence>
<xsd:element name="AssigningPartyId" type="AssigningOrganizationPartyId"/>
<xsd:element name="IssuingState" type="IssuingState" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationContact

Super-types:None
Sub-types:

NameOrganizationContact
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PersonNameContact name Optional 
TelephoneContact telephone numbers Optional 
EMailAddressContact Email address Optional 
FaxContact Fax number Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 

XML Instance Representation
<...>
<PersonName> OrganizationContactPersonName </PersonName> [0..1] ?
<Telephone> OrganizationPartyTelephone </Telephone> [0..*] ?
<EMailAddress> OrganizationPartyEmail </EMailAddress> [0..*] ?
<Fax> OrganizationPartyFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethodOrganization </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationContact">
<xsd:sequence>
<xsd:element name="PersonName" type="OrganizationContactPersonName" minOccurs="0"/>
<xsd:element name="Telephone" type="OrganizationPartyTelephone" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EMailAddress" type="OrganizationPartyEmail" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Fax" type="OrganizationPartyFax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PreferredContactMethod" type="PreferredContactMethodOrganization" minOccurs="0"/>
<xsd:element name="ContactTime" type="ContactTime" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OrganizationContactExtended

Super-types:OrganizationContact < OrganizationContactExtended (by extension)
Sub-types:None

NameOrganizationContactExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PersonNameContact name Optional 
TelephoneContact telephone numbers Optional 
EMailAddressContact Email address Optional 
FaxContact Fax number Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PreferredLanguageOrganization's preferred language Optional 

XML Instance Representation
<...>
<PersonName> OrganizationContactPersonName </PersonName> [0..1] ?
<Telephone> OrganizationPartyTelephone </Telephone> [0..*] ?
<EMailAddress> OrganizationPartyEmail </EMailAddress> [0..*] ?
<Fax> OrganizationPartyFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethodOrganization </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PreferredLanguage> PreferredLanguage </PreferredLanguage> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationContactExtended">
<xsd:complexContent>
<xsd:extension base="OrganizationContact">
<xsd:sequence>
<xsd:element name="PreferredLanguage" type="PreferredLanguage" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationContactPersonName

Super-types:None
Sub-types:None

NameOrganizationContactPersonName
Abstractno
DocumentationDerived from oa:PersonName
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
GivenNameFirst Name of business party Required 
FamilyNameLast Name of business party Required 
FormattedNameFull Name of business party. Format for name should be "First Last" with no commas between first and last name Optional 

XML Instance Representation
<...>
<GivenName> Name </GivenName> [1] ?
<FamilyName> Name </FamilyName> [1] ?
<FormattedName> Name </FormattedName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationContactPersonName">
<xsd:sequence>
<xsd:element name="GivenName" type="Name"/>
<xsd:element name="FamilyName" type="Name"/>
<xsd:element name="FormattedName" type="Name" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OrganizationPartyBase

Super-types:PartyBase < OrganizationPartyBase (by extension)
Sub-types:

NameOrganizationPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="AlternatePartyIds" type="OrganizationalPartyAlternatePartyId" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Name" type="CompanyName" minOccurs="0"/>
<xsd:element name="Address" type="OrganizationAddress" minOccurs="0"/>
<xsd:element name="DBAName" type="DBAName" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationPartyEmail

Super-types:xsd:string < OrganizationPartyEmail (by extension)
Sub-types:None

NameOrganizationPartyEmail
Abstractno
DocumentationOrganization email
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="OrganizationPartyEmail">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationPartyFax

Super-types:xsd:string < OrganizationPartyFax (by extension)
Sub-types:None

NameOrganizationPartyFax
Abstractno
DocumentationOrganizationFax number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="OrganizationPartyFax">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationPartyTelephone

Super-types:xsd:string < OrganizationPartyTelephone (by extension)
Sub-types:None

NameOrganizationPartyTelephone
Abstractno
DocumentationOrganizationParty telephone number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 
exten Required 

XML Instance Representation
<...

exten="Note [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="OrganizationPartyTelephone">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="ContactTelephoneNumberOrganizationDescription"/>
<xsd:attribute name="exten" type="Note"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): PartyBase

Super-types:None
Sub-types:

NamePartyBase
Abstractno
DocumentationDerived from oa:Party
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="PartyBase">
<xsd:sequence>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): PartyId

Super-types:xsd:string < Id (by extension) < PartyId (by extension)
Sub-types:None

NamePartyId
Abstractno
DocumentationParty Identification Number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="PartyId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Percent

Super-types:xsd:decimal < Percent (by extension)
Sub-types:None

NamePercent
Abstractno
DocumentationPercent
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Percent">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): RegulatoryId

Super-types:xsd:string < Id (by extension) < RegulatoryId (by extension)
Sub-types:None

NameRegulatoryId
Abstractno
DocumentationIdentification number assigned to regulatory requirement (Ex: Pedimento number assigned to vehicle in Mexico)
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="RegulatoryId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): RegulatoryRequirements

Super-types:None
Sub-types:None

NameRegulatoryRequirements
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
RegulatoryTypeType of regulatory requirement (Ex: customs) Optional 
RegulatoryIdIdentification number assigned to regulatory requirement (Ex: Pedimento number assigned to vehicle in Mexico Optional 
RegulatoryDateDate regulatory requirement identification number is assigned (Ex: Date Pedimento number is assigned to vehicle) Optional
In YYYY-MM-DD format.
 

XML Instance Representation
<...>
<RegulatoryType> RegulatoryType </RegulatoryType> [0..1] ?
<RegulatoryId> RegulatoryId </RegulatoryId> [0..1] ?
<RegulatoryDate> RegulatoryDate </RegulatoryDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="RegulatoryRequirements">
<xsd:sequence>
<xsd:element name="RegulatoryType" type="RegulatoryType" minOccurs="0"/>
<xsd:element name="RegulatoryId" type="RegulatoryId" minOccurs="0"/>
<xsd:element name="RegulatoryDate" type="RegulatoryDate" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ResponseVerb

Super-types:Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension)
Sub-types:

NameResponseVerb
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 
OriginalBODId Optional 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
>
<OriginalBODId> xsd:NMTOKEN </OriginalBODId> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="ResponseVerb">
<xsd:complexContent>
<xsd:extension base="ConfirmableVerb">
<xsd:sequence>
<xsd:element name="OriginalBODId" type="xsd:NMTOKEN" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): RestrictionDescription

Super-types:xsd:string < Description (by extension) < RestrictionDescription (by extension)
Sub-types:None

NameRestrictionDescription
Abstractno
DocumentationDescription of vehicle use restrictions
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="RestrictionDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): SecondaryDealerNumber

Super-types:xsd:string < Id (by extension) < SecondaryDealerNumber (by extension)
Sub-types:None

NameSecondaryDealerNumber
Abstractno
DocumentationIdentifies secondary dealer number if different than primary "Dealer Number"
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="SecondaryDealerNumber">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Sender

Super-types:SenderBase < Sender (by extension)
Sub-types:None

NameSender
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
LogicalIdProvides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network Optional 
ComponentProvides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name Required 
TaskDescribes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. Required 
ReferenceIdEnables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD Optional 
AuthorizationIdIdentifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. Optional 
CreatorNameCodeDCS Software Creator Code Required 
SenderNameCodeAdditional information about the sending platform (i.e., Short MFG or DSP code). Required
Must use a valid code from the ShortMfg/RSP list on http://www.starstandards.org
 
SenderURIPhysical address of the sender Optional 
DealerNumberDealer Code of source of information Optional
Dealer Number is Required if originating from DMS.
 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountrySource Dealer country location Optional 
LanguageThis code is used to define the language of the data used in this transaction Optional 
DeliverPendingMailIndIndicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. Optional
1 - Receive Pending Mail. 0 - Do not receive pending mail.
 
PasswordToken for application specific authentication. Used to authenticate dealership/users through application specific security Optional 
SystemVersionThe sender's software version number. Optional 
PartyIdThe Party Id field uniquely identifies the Sender of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. Optional 
LocationIdThe Location Id field uniquely identifies the location of the Sender of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. Optional 
ServiceIdThe Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<LogicalId> Text </LogicalId> [0..1] ?
<Component> Text </Component> [1] ?
<Task> Text </Task> [1] ?
<ReferenceId> Reference </ReferenceId> [0..1] ?
<AuthorizationId> Id </AuthorizationId> [0..1] ?
<CreatorNameCode> Text </CreatorNameCode> [1] ?
<SenderNameCode> ShortMfg </SenderNameCode> [1] ?
<SenderURI> URI </SenderURI> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<Language> Language </Language> [0..1] ?
<DeliverPendingMailInd> Indicator </DeliverPendingMailInd> [0..1] ?
<Password> Text </Password> [0..1] ?
<SystemVersion> SystemVersion </SystemVersion> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Sender">
<xsd:complexContent>
<xsd:extension base="SenderBase">
<xsd:sequence>
<xsd:element name="CreatorNameCode" type="Text"/>
<xsd:element name="SenderNameCode" type="ShortMfg"/>
<xsd:element name="SenderURI" type="URI" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="Language" type="Language" minOccurs="0"/>
<xsd:element name="DeliverPendingMailInd" type="Indicator" minOccurs="0"/>
<xsd:element name="Password" type="Text" minOccurs="0"/>
<xsd:element name="SystemVersion" type="SystemVersion" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): SenderBase

Super-types:None
Sub-types:

NameSenderBase
Abstractno

Data Elements and Components