Implementation Guideline
Get Parts Locator
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Get Parts Locator
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
This document is a guideline on how to use the Get Parts Locator Business Object Document (BOD). Get Parts Locator has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Get Parts Locator 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 Get Parts Locator, this BOD could be used to send Get Parts Locator information between any two business parties.
The Get Parts Locator Implementation Guidelines provide detailed information regarding the structure and meaning of the Get Parts Locator BOD and corresponds directly to the Get Parts Locator 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 Get Parts Locator Implementation Guidelines must be used in concert with the Get Parts Locator 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 Get Parts Locator 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 Get Parts Locator BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Get Parts Locator 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.
STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Get Parts Locator 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.
The Parts Locator Binary Collaboration starts with the transmission of a Parts Locator from the Dealer to the OEM. In response, the OEM may send Parts Locator information back to the Dealer acknowledging the requested parts, identifying backordered items, etc. This process occurs on demand as is needed. Note: This scenario is an example of how the Parts Locator BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Get Parts Locator 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.
| Target Namespace | http://www.starstandards.org/STAR |
|---|---|
| Element and Attribute Namespaces |
|
| Documentation | This 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/. |
| Prefix | Namespace |
|---|---|
| Default namespace | http://www.starstandards.org/STAR |
| xml | http://www.w3.org/XML/1998/namespace |
| star | http://www.starstandards.org/STAR |
| xsd | http://www.w3.org/2001/XMLSchema |
| Name | ApplicationArea |
|---|---|
| Type | ApplicationArea |
| Nillable | no |
| Abstract | no |
| Documentation | 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. 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. |
|
| Name | Get |
|---|---|
| Type | Get |
| Nillable | no |
| Abstract | no |
| Documentation | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. More information at: http://www.openapplications.org/oagis. |
| Name | GetPartsLocator |
|---|---|
| Type | GetPartsLocator |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | PartsLocatorHeader |
| Nillable | no |
| Abstract | no |
| Documentation | The Header component represents summary information for the entire Parts Locator. More information at: http://www.starstandards.org. |
| Name | LocatedLines |
|---|---|
| Type | LocatedLines |
| Nillable | no |
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability was determined. More information at: http://www.starstandards.org. |
| Name | PartsLocator |
|---|---|
| Type | PartsLocator |
| Nillable | no |
| Abstract | no |
| Documentation | The scope of this BOD is to define the Parts Locator process for individual dealers using either OEM or third party parts locator retrieval services to locate parts at eithe nearby dealership or parts distribution warehouse. More information at: http://www.starstandards.org. |
| Name | RequestedLines |
|---|---|
| Type | RequestedLines |
| Nillable | no |
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Name | SupplyingParties |
|---|---|
| Type | SupplyingParties |
| Nillable | no |
| Abstract | no |
| Documentation | Represents the parties that have the requested part(s) available. More information at: http://www.starstandards.org. |
| Name | SupplyingPartyLocations |
|---|---|
| Type | SupplyingPartyLocations |
| Nillable | no |
| Abstract | no |
| Documentation | Represents the locations of the available part(s). This could be a Parts Distribution Center (PDC) or a dealership location. More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | AddressBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
| City | Is the City of the Address. | Required | |
| County | County in which the Address is in. | Optional | |
| StateOrProvince | Is the State or Province of a given Address. | Required |
Reference valid value rule USPS
|
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required |
Reference valid value rule USPS
|
| Super-types: | xsd:decimal < Amount (by extension) |
|---|---|
| Sub-types: | None |
| Name | Amount |
|---|---|
| Abstract | no |
| Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| currency | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ApplicationArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Sender | Identifies 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 | |
| CreationDateTime | is 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
|
| Signature | If 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 | |
| BODId | The 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 | |
| Destination | Information related to the receiver of the BOD | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | BusinessObjectDocument |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| revision | This 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 | |
| release | Indicates the OAGIS release that this BOD belongs. | Optional | |
| environment | Indicates 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 | |
| lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
| bodVersion | Deprecated 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 |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | 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. | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ConfirmableVerb |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| confirm | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required |
| Super-types: | xsd:decimal < Amount (by extension) < DealerNetPrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerNetPrice |
|---|---|
| Abstract | no |
| Documentation | Dealer net price of the individual part for the quantity indicated. More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < DealerPartyBase (by extension) < DealerParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional | |
| Address | Dealer party address | Optional | |
| SalesContact | Dealer party contact information | Optional | |
| SalesPersonName | Name of Salesperson. Format for name should be "First Last" with no commas between first and last name | Optional | |
| DepartmentType | Identifies the internal department | Optional | |
| OrganizationId | Member Identification number of affiliate organization | Optional | |
| OrganizationName | OrganizationName | Optional | |
| SelectionMethod | Method used to select dealer Example: PF for preferred, PM for PMA, DI for distance, etc. | Optional |
| Super-types: | PartyBase < DealerPartyBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | DealerPartyBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional |
| Super-types: | xsd:string < Description (by extension) |
|---|---|
| Sub-types: | None |
| Name | Description |
|---|---|
| Abstract | no |
| Documentation | Description More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| language | The ISO language code that the description is written. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Destination |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DestinationNameCode | Code 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
|
| DestinationURI | Physical address of the destination | Optional | |
| DestinationSoftwareCode | Additional information about the destination application | Optional | |
| DestinationSoftware | For which software destination file is intended (may not be known). | Optional | |
| DealerNumber | Target Dealer Code receiving information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Target Dealer country location | Optional | |
| PartyId | The 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 | |
| LocationId | The 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 | |
| ServiceId | The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | xsd:string < Id (by extension) < DocumentId (by extension) |
|---|---|
| Sub-types: | None |
| Name | DocumentId |
|---|---|
| Abstract | no |
| Documentation | Is the identifier for the document. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SelectExpression | Allows the 1-n number of selection expressions for the information to be returned. | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) < Get (by extension) |
|---|---|
| Sub-types: | None |
| Name | Get |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| show | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | BusinessObjectDocument < GetPartsLocator (by extension) |
|---|---|
| Sub-types: | None |
| Name | GetPartsLocator |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ApplicationArea | 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. | Required | |
| DataArea | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | GetPartsLocatorDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Get | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. | Required | |
| PartsLocator | The scope of this BOD is to define the Parts Locator process for individual dealers using either OEM or third party parts locator retrieval services to locate parts at eithe nearby dealership or parts distribution warehouse. | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | HeaderBase |
|---|---|
| Abstract | no |
| Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
| Super-types: | xsd:string < Id (by extension) |
|---|---|
| Sub-types: | None |
| Name | Id |
|---|---|
| Abstract | no |
| Documentation | Party Identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < ItemId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ItemId |
|---|---|
| Abstract | no |
| Documentation | Item part number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < ItemIdDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | ItemIdDescription |
|---|---|
| Abstract | no |
| Documentation | Item part number detail description More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < ItemQuantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | ItemQuantity |
|---|---|
| Abstract | no |
| Documentation | Quantity of Part number. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | LocatedLine |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability was determined. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LocatedLineUID | A unique identifier of the record. This value should have no business meaning and serves the purpose as the primary key in this component. | Required | |
| ParentLocatedLineUID | For a child LocatedLine, this value is equal to the LocatedLine.LocatedLineUID value of the parent LocatedLine. | Optional | |
| SupplyingPartyUID | This field identifies the supplying party for the located line and must be equal to one of the SupplyingParties.Party.SupplyingPartyUID values. | Required | |
| SupplyingPartyLocationUID | The SupplyingPartyLocation.SupplyingPartyLocationUID of the supplying party's location. The combination of SupplyingPartyUID and SupplyingPartyLocationUID must equal one of the records in SupplyingPartyLocations. This field is only poplated when the LocatedLine has no child lines. | Optional | |
| RequestedLineUID | Only populated for LocatedLine components that do not have a parent LocatedLine, this field represents the LineNumber of the RequestedLine for which the pricing/availability is for. Must be equal to one of the RequestedLine.LineNumber values. | Optional | |
| LineNumber | LocatedLine components in the BOD can be grouped by RequestedLineUID or ParentLocatedLineUID. The value of this field represents a unique identifier for a locatedLine within one of those groups. Within one of these groups, LineNumber values should start at 1 and increment by 1. | Optional | |
| Part | Represents informatoin about the part for which pricing/availability information is being provided. | Required | |
| ItemQuantity | The quantity of the part with the AvailabilityStatus at the location/supplier indicated within this component. | Required | |
| DealerNetPrice | The total price to purchase the entire quantity of parts indicated within this component. | Optional | |
| SuggestedRetailPrice | The MSRP to purchase the entire quantity of parts indicated within this component. | Optional | |
| AvailabilityStatus | Indicates the status of the part at the supplying location. | Optional | |
| ChildLineReasonCode | For LocatedLines which have children, this value indicates the reason the children exist. | Optional | |
| ChildLinePricingAppliesInd | For LocatedLines which have children, this value indicates whether the pricing of the part is given by the parent line or its children. | Optional | |
| LastSoldDate | The date the part was last sold. | Optional | |
| LastInventoryDate | The last date inventory was updated for this part. | Optional | |
| PriceExplanation | An explanatory note for the pricing. | Optional | |
| SupplierItemId | The OEM part number. If hte part is sold by a distributor, this is not their part number. Works in conjunction with PartManufacturer. | Optional | |
| LineStatus | The Line Status component provides a reason for the availability status of a part and may also provide additional information about the part. . | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | LocatedLines |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LocatedLine | Represents the parts for which pricing and availability was determined. | Required |
| Super-types: | xsd:string < UID (by extension) < LocatedLineUID (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocatedLineUID |
|---|---|
| Abstract | no |
| Documentation | A unique identifier of the record. This value should have no business meaning and serves the purpose as the primary key in this component. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocationId |
|---|---|
| Abstract | no |
| Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < LocationName (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocationName |
|---|---|
| Abstract | no |
| Documentation | A name to identify the location. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | MinimumAcknowledgementStatus |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| StatusType | Defines the type of status that occured. EX: S-Success, E-Error, W-Warning, I-Info, A-Abort | Optional | |
| StatusCode | A code identifying the reason for the status message. | Optional | |
| StatusText | Descriptive status text. | Optional |
| Super-types: | AddressBase < OrganizationAddress (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationAddress |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
| City | Is the City of the Address. | Required | |
| County | County in which the Address is in. | Optional | |
| StateOrProvince | Is the State or Province of a given Address. | Required |
Reference valid value rule USPS
|
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required |
Reference valid value rule USPS
|
| UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | OrganizationContact |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PersonName | Contact name | Optional | |
| Telephone | Contact telephone numbers | Optional |
If the address has a North American country code,
the telephone number must be a minimum of 10
numbers.
|
| EMailAddress | Contact Email address | Optional |
Should conform to the Internet message format as set
forth by RFC 8822.
|
| Fax | Contact Fax number | Optional |
If the address has a North American country code,
the telephone number must be a minimum of 10
numbers.
|
| PreferredContactMethod | Preferred contact method | Optional | |
| ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | OrganizationContactPersonName |
|---|---|
| Abstract | no |
| Documentation | Derived from oa:PersonName More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| GivenName | First Name of business party | Required | |
| FamilyName | Last Name of business party | Required | |
| FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional |
| Super-types: | xsd:string < Id (by extension) < OrganizationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationId |
|---|---|
| Abstract | no |
| Documentation | Member Identification number of affiliate organization More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < OrganizationPartyEmail (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyEmail |
|---|---|
| Abstract | no |
| Documentation | Organization email More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < OrganizationPartyFax (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyFax |
|---|---|
| Abstract | no |
| Documentation | OrganizationFax number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < OrganizationPartyTelephone (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyTelephone |
|---|---|
| Abstract | no |
| Documentation | OrganizationParty telephone number More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required | ||
| exten | Required |
| Super-types: | xsd:string < UID (by extension) < ParentLocatedLineUID (by extension) |
|---|---|
| Sub-types: | None |
| Name | ParentLocatedLineUID |
|---|---|
| Abstract | no |
| Documentation | For a child LocatedLine, this value is equal to the LocatedLine.LocatedLineUID value of the parent LocatedLine. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < PartManufacturer (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartManufacturer |
|---|---|
| Abstract | no |
| Documentation | Identifes the part manufacturer. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | PartsBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ItemId | Item part number identifier | Optional | |
| ItemIdDescription | Item part number detail description | Optional | |
| PartType | Specifies whether the parts are indicated by manufacturer part code or Part Number | Optional | |
| SupplierItemId | Supplier identification of part on order. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | PartsLocator |
|---|---|
| Abstract | no |
| Documentation | STAR Version 3.0 - Draft More information at: http://www.starstandards.org. STAR Version 2.1, STAR approved 04/20/2005; effective date 07/04/2005 More information at: http://www.starstandards.org. STAR Version 2.0, STAR approved 05/07/2004; effective date 07/04/2004 More information at: http://www.starstandards.org. STAR Version 1.0, STAR approved 10/4/2002; OAGI approved 10/17/2002; effective date 1/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | The Header component represents summary information for the entire Parts Locator. | Required | |
| RequestedLines | Represents the parts for which pricing and availability is being requested. | Optional | |
| LocatedLines | Represents the parts for which pricing and availability was determined. | Optional | (INACTIVE)
This component is only to be used in:
ShowPartsLocator |
| SupplyingParties | Represents the parties that have the requested part(s) available. | Optional | |
| SupplyingPartyLocations | Represents the locations of the available part(s). This could be a Parts Distribution Center (PDC) or a dealership location. | Optional |
| Super-types: | HeaderBase < PartsLocatorHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartsLocatorHeader |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
| DocumentId | The primary DocumentId of the document for the given content. | Required | |
| LocatorCode | Identifies the type of locator transaction being used. | Optional | |
| RequestedSearchCriteriaType | Defines whether the search applies to dealers, suppliers, or both dealers and suppliers. | Optional | |
| RequestedSearchCriteria | Represents information about the search criteria being defined for all requested lines. | Optional | |
| Requestor | Represents information about the party requesting the part(s). | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | PartsLocatorSupplyingParty |
|---|---|
| Abstract | no |
| Documentation | The PartsLocatorSupplyingParty represents a party that has the availability information on the requested part(s). More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SupplyingPartyUID | This field identifies the supplying party for the located line and must be equal to one of the SupplyingParties.Party.SupplyingPartyUID values. | Required | |
| PartyId | An logical identifier for the Party. This would either be a Short Manufacturer Code for the OEM or aftermarket distributor, or a dealer number. | Required | |
| PartyName | The name of the Party. The Party in the context of a Parts Locator is either a dealer, OEM supplier, or aftermarket distributor. | Optional | |
| PartyType | Identifies if the supplier is a dealer or a supplier (OEM or aftermarket distributor). | Required | |
| ZoneCode | For dealers only, identifies the dealer's supplier defined zone code. | Optional | |
| DistrictCode | For dealers only, identifies the dealer's supplier defined district code. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | PartyBase |
|---|---|
| Abstract | no |
| Documentation | Derived from oa:Party More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional |
| Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartyId |
|---|---|
| Abstract | no |
| Documentation | Party Identification Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | Quantity |
|---|---|
| Abstract | no |
| Documentation | A decimal value with uom More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RequestedLine |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| RequestedLineUID | Only populated for LocatedLine components that do not have a parent LocatedLine, this field represents the LineNumber of the RequestedLine for which the pricing/availability is for. Must be equal to one of the RequestedLine.LineNumber values. | Required | |
| LineNumber | An identifier for the line as assigned by the requesting party. Must be unique among all other RequestedLine.LineNumber values. Must be an integer. Smallest value must be 1 with other values being consecutive integers. | Optional | |
| Part | Represents information abou tthe part for which pricing/availability information is being provided. | Required | |
| ItemQuantity | The quantity of the part requested. | Optional | |
| DealerNetPrice | The expected net price for the quantity requested. If quantity was not provided, the expected net price for a quantity of 1 "ea". May be used by the supplying party to resolve ambiguous part numbers. | Optional | |
| SuggestedRetailPrice | The expected suggested retail price for the quantity requested. If quantity was not provided, the expected suggested retail price for a quantity of 1 "ea". May be used by the supplying party to resolve ambiguous part numbers. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RequestedLines |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| RequestedLine | Represents a part for which pricing and availability is being requested. | Required |
| Super-types: | xsd:string < UID (by extension) < RequestedLineUID (by extension) |
|---|---|
| Sub-types: | None |
| Name | RequestedLineUID |
|---|---|
| Abstract | no |
| Documentation | Only populated for LocatedLine components that do not have a parent LocatedLine, this field represents the LineNumber of the RequestedLine for which the pricing/availability is for. Must be equal to one of the RequestedLine.LineNumber values. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RequestedSearchCriteria |
|---|---|
| Abstract | no |
| Documentation | Represents information about the search criteria being defined for all requested lines. More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DistrictCode | The dealer districts to search when searching specific dealers by district. | Optional | |
| ZoneCode | The dealer zones to search when searching specific dealers by zone. | Optional | |
| SearchRadius | The search radius based on the searching party's location. | Optional |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | RequestVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | xsd:decimal < Quantity (by extension) < SearchRadius (by extension) |
|---|---|
| Sub-types: | None |
| Name | SearchRadius |
|---|---|
| Abstract | no |
| Documentation | The search radius based on the searching party's location. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < SecondaryDealerNumber (by extension) |
|---|---|
| Sub-types: | None |
| Name | SecondaryDealerNumber |
|---|---|
| Abstract | no |
| Documentation | Identifies secondary dealer number if different than primary "Dealer Number" More information at: http://www.starstandard.org. |
| Super-types: | SenderBase < Sender (by extension) |
|---|---|
| Sub-types: | None |
| Name | Sender |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LogicalId | Provides 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 | |
| Component | Provides 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 | |
| Task | Describes 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 | |
| ReferenceId | Enables 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 | |
| AuthorizationId | Identifyies 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 | |
| CreatorNameCode | DCS Software Creator Code | Required | |
| SenderNameCode | Additional 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
|
| SenderURI | Physical address of the sender | Optional | |
| DealerNumber | Dealer Code of source of information | Optional | |
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Source Dealer country location | Optional | |
| Language | This code is used to define the language of the data used in this transaction | Optional | |
| DeliverPendingMailInd | Indicates 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 | |
| Password | Token for application specific authentication. Used to authenticate dealership/users through application specific security | Optional | |
| SystemVersion | The sender's software version number. | Optional | |
| PartyId | The 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 | |
| LocationId | The 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 | |
| ServiceId | The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | SenderBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LogicalId | Provides 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 | |
| Component | Provides 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 | |
| Task | Describes 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 | |
| ReferenceId | Enables 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 | |
| AuthorizationId | Identifyies 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 |
| Super-types: | xsd:string < Id (by extension) < ServiceId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ServiceId |
|---|---|
| Abstract | no |
| Documentation | The Service Id field identifies the particular service to or from which a message is being sent, e.g., an inventory service. More information at: http://www.starstandard.org. |
| Super-types: | PartsBase < ShipPart (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShipPart |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| ItemId | Item part number identifier | Optional | |
| ItemIdDescription | Item part number detail description | Optional | |
| PartType | Specifies whether the parts are indicated by manufacturer part code or Part Number | Optional | |
| SupplierItemId | Supplier identification of part on order. | Optional | |
| PartClass | Gifts, literature, keys, regular parts – Inventory Class code (if any) used in DMS system. | Optional | |
| PartManufacturer | Identifes the part manufacturer | Optional | |
| ClassCode | Identifies class of part (i.e., accessories, replacement, etc.) | Optional | |
| HazmatInd | Indicates whether this part is considered a hazardous material (e.g., air bag). | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Signature |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifyingAgency | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:decimal < Amount (by extension) < SuggestedRetailPrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | SuggestedRetailPrice |
|---|---|
| Abstract | no |
| Documentation | Suggested retail price of the individual part for the quantity indicated. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < ItemId (by extension) < SupplierItemId (by extension) |
|---|---|
| Sub-types: | None |
| Name | SupplierItemId |
|---|---|
| Abstract | no |
| Documentation | Supplier identification of part on order. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | SupplyingParties |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Party | Represents the parts for which pricing and availability was determined. | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | SupplyingPartyLocation |
|---|---|
| Abstract | no |
| Documentation | The Supplying Locations Component represents the locations of the available part(s). This could be a Parts Distrubution Center (PDC) or a dealership location. More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SupplyingPartyLocationUID | The SupplyingPartyLocation.SupplyingPartyLocationUID of the supplying party's location. The combination of SupplyingPartyUID and SupplyingPartyLocationUID must equal one of the records in SupplyingPartyLocations. This field is only poplated when the LocatedLine has no child lines. | Required | |
| SupplyingPartyUID | This field identifies the supplying party for the located line and must be equal to one of the SupplyingParties.Party.SupplyingPartyUID values. | Required | |
| LocationName | A name to identify the location. | Required | |
| Address | Address of the SupplyingLocation. | Optional | |
| Contact | Contact information for the SupplyingLocation | Optional | |
| ZoneCode | For dealers only, identifies the dealer's supplier defined zone code. | Optional | |
| DistrictCode | For dealers only, identifies the dealer's supplier defined district code. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | SupplyingPartyLocations |
|---|---|
| Abstract | no |
| Documentation | Represents the parts for which pricing and availability is being requested. More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SupplyingPartyLocation | Represents the parts for which pricing and availability was determined. | Required |
| Super-types: | xsd:string < UID (by extension) < SupplyingPartyLocationUID (by extension) |
|---|---|
| Sub-types: | None |
| Name | SupplyingPartyLocationUID |
|---|---|
| Abstract | no |
| Documentation | The SupplyingPartyLocation.SupplyingPartyLocationUID of the supplying party's location. The combination of SupplyingPartyUID and SupplyingPartyLocationUID must equal one of the records in SupplyingPartyLocations. This field is only poplated when the LocatedLine has no child lines. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < UID (by extension) < SupplyingPartyUID (by extension) |
|---|---|
| Sub-types: | None |
| Name | SupplyingPartyUID |
|---|---|
| Abstract | no |
| Documentation | This field identifies the supplying party for the located line and must be equal to one of the SupplyingParties.Party.SupplyingPartyUID values. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < UID (by extension) |
|---|---|
| Sub-types: | None |
| Name | UID |
|---|---|
| Abstract | no |
| Documentation | Unique identification used to defined primary and foreign key fields. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:string < AddressLine (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AddressLine |
|---|---|
| Documentation | Indicates the multiple lines of an address. The first line is typically the street name and number. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < AvailabilityStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AvailabilityStatus |
|---|---|
| Documentation | Indicates the status of the part at the supplying location. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| In Stock | Part is in stock. |
| Out Of Stock | Part is in stock. |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Indicator (by restriction) < ChildLinePricingAppliesInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ChildLinePricingAppliesInd |
|---|---|
| Documentation | Identifies if the pricing of the child line(s) applies. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < ChildLineReasonCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ChildLineReasonCode |
|---|---|
| Documentation | The reason this line has child lines. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Multi-Condition | One or more child lines exist due to differences in allocation such as back orders and warehouse supply. |
| Kit Exploded | One or more child lines exists to express the availability of parts within the kit. |
| Superseded | One or more child lines exist to express the ordered part was superseded by the listed parts. |
| Substituted | One or more child lines exist to express the ordered part was substituted by the listed parts. |
| Super-types: | xsd:string < City (by restriction) |
|---|---|
| Sub-types: | None |
| Name | City |
|---|---|
| Documentation | City of the Address. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ClassCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ClassCode |
|---|---|
| Documentation | Identifies class of part (i.e., accessories, replacement, etc.). More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Code |
|---|---|
| Documentation | Unique code name More information at: http://www.starstandard.org. |
| Super-types: | xsd:NMTOKEN < ConfirmType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ConfirmType |
|---|
| Code Value | Description |
|---|---|
| Always | |
| OnChange | |
| Never |
| Super-types: | xsd:string < ContactTelephoneNumberOrganizationDescription (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContactTelephoneNumberOrganizationDescription |
|---|---|
| Documentation | Contact Telephone Number Organization Description More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Day Phone | Day Phone |
| Cell Phone | Cell Phone |
| Pager | Pager |
| Other | Other |
| Super-types: | xsd:string < Note (by restriction) < ContactTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContactTime |
|---|---|
| Documentation | Preferred contact time (i.e. Best day/time to reach the contact. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Country (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Country |
|---|---|
| Documentation | Country in which the Address is in. Conforms to ISO 3166-2. AF -AFGHANISTAN AL -ALBANIA DZ -ALGERIA AS -AMERICAN SAMOA AD -ANDORRA AO -ANGOLA AI -ANGUILLA AQ -ANTARCTICA AG -ANTIGUA AND BARBUDA AR -ARGENTINA AM -ARMENIA AW -ARUBA AU -AUSTRALIA AT -AUSTRIA AZ -AZERBAIJAN BS -BAHAMAS BH -BAHRAIN BD -BANGLADESH BB -BARBADOS BY -BELARUS BE -BELGIUM BZ -BELIZE BJ -BENIN BM -BERMUDA BT -BHUTAN BO -BOLIVIA BA -BOSNIA AND HERZEGOVINA BW -BOTSWANA BV -BOUVET ISLAND BR -BRAZIL IO-BRITISH INDIAN OCEAN TERRITORY BN -BRUNEI DARUSSALAM BG -BULGARIA BF -BURKINA FASO BI -BURUNDI KH -CAMBODIA CM -CAMEROON CA -CANADA CV -CAPE VERDE KY -CAYMAN ISLANDS CF -CENTRAL AFRICAN REPUBLIC TD -CHAD CL -CHILE CN -CHINA CX -CHRISTMAS ISLAND CC -COCOS (KEELING) ISLANDS CO -COLOMBIA KM -COMOROS CG -CONGO CD -CONGO, THE DEMOCRATIC REPUBLIC OF THE CK -COOK ISLANDS CR -COSTA RICA CI -CÔTE D'IVOIRE HR -CROATIA CU -CUBA CY -CYPRUS CZ -CZECH REPUBLIC DK -DENMARK DJ -DJIBOUTI DM -DOMINICA DO -DOMINICAN REPUBLIC EC -ECUADOR EG -EGYPT SV -EL SALVADOR GQ -EQUATORIAL GUINEA ER -ERITREA EE -ESTONIA ET -ETHIOPIA FK -FALKLAND ISLANDS (MALVINAS) FO -FAROE ISLANDS FJ -FIJI FI -FINLAND FR -FRANCE GF -FRENCH GUIANA PF -FRENCH POLYNESIA TF -FRENCH SOUTHERN TERRITORIES GA -GABON GM -GAMBIA GE -GEORGIA DE -GERMANY GH -GHANA GI -GIBRALTAR GR -GREECE GL -GREENLAND GD -GRENADA GP -GUADELOUPE GU -GUAM GT -GUATEMALA GN -GUINEA GW -GUINEA-BISSAU GY -GUYANA HT -HAITI HM -HEARD ISLAND AND MCDONALD ISLANDS VA -HOLY SEE (VATICAN CITY STATE) HN -HONDURAS HK -HONG KONG HU -HUNGARY IS -ICELAND IN -INDIA ID -INDONESIA IR -IRAN, ISLAMIC REPUBLIC OF IQ -IRAQ IE -IRELAND IL -ISRAEL IT -ITALY JM -JAMAICA JP -JAPAN JO -JORDAN KZ -KAZAKHSTAN KE -KENYA KI -KIRIBATI KP -KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KR -KOREA, REPUBLIC OF KW -KUWAIT KG -KYRGYZSTAN LA -LAO PEOPLE'S DEMOCRATIC REPUBLIC LV -LATVIA LB -LEBANON LS -LESOTHO LR -LIBERIA LY -LIBYAN ARAB JAMAHIRIYA LI -LIECHTENSTEIN LT -LITHUANIA LU -LUXEMBOURG MO -MACAO MK -MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MG -MADAGASCAR MW -MALAWI MY -MALAYSIA MV -MALDIVES ML -MALI MT -MALTA MH -MARSHALL ISLANDS MQ -MARTINIQUE MR -MAURITANIA MU -MAURITIUS YT -MAYOTTE MX -MEXICO FM -MICRONESIA, FEDERATED STATES OF MD -MOLDOVA, REPUBLIC OF MC -MONACO MN -MONGOLIA MS -MONTSERRAT MA -MOROCCO MZ -MOZAMBIQUE MM -MYANMAR NA -NAMIBIA NR -NAURU NP -NEPAL NL -NETHERLANDS AN -NETHERLANDS ANTILLES NC -NEW CALEDONIA NZ -NEW ZEALAND NI -NICARAGUA NE -NIGER NG -NIGERIA NU -NIUE NF -NORFOLK ISLAND MP -NORTHERN MARIANA ISLANDS NO -NORWAY OM -OMAN PK -PAKISTAN PW -PALAU PS -PALESTINIAN TERRITORY, OCCUPIED PA -PANAMA PG -PAPUA NEW GUINEA PY -PARAGUAY PE -PERU PH -PHILIPPINES PN -PITCAIRN PL -POLAND PT -PORTUGAL PR -PUERTO RICO QA -QATAR RE -RÉUNION RO -ROMANIA RU -RUSSIAN FEDERATION RW -RWANDA SH -SAINT HELENA KN -SAINT KITTS AND NEVIS LC -SAINT LUCIA PM -SAINT PIERRE AND MIQUELON VC -SAINT VINCENT AND THE GRENADINES WS -SAMOA SM -SAN MARINO ST -SAO TOME AND PRINCIPE SA -SAUDI ARABIA SN -SENEGAL CS -SERBIA AND MONTENEGRO SC -SEYCHELLES SL -SIERRA LEONE SG -SINGAPORE SK -SLOVAKIA SI -SLOVENIA SB -SOLOMON ISLANDS SO -SOMALIA ZA -SOUTH AFRICA GS -SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS ES -SPAIN LK -SRI LANKA SD -SUDAN SR -SURINAME SJ -SVALBARD AND JAN MAYEN SZ -SWAZILAND SE -SWEDEN CH -SWITZERLAND SY -SYRIAN ARAB REPUBLIC TW -TAIWAN, PROVINCE OF CHINA TJ -TAJIKISTAN TZ -TANZANIA, UNITED REPUBLIC OF TH -THAILAND TL -TIMOR-LESTE TG - TOGO TK -TOKELAU TO -TONGA TT -TRINIDAD AND TOBAGO TN -TUNISIA TR -TURKEY TM -TURKMENISTAN TC -TURKS AND CAICOS ISLANDS TV -TUVALU UG -UGANDA UA -UKRAINE AE -UNITED ARAB EMIRATES GB -UNITED KINGDOM US -UNITED STATES UM -UNITED STATES MINOR OUTLYING ISLANDS UY -URUGUAY UZ -UZBEKISTAN VU -VANUATU VE -VENEZUELA VN -VIET NAM VG -VIRGIN ISLANDS, BRITISH VI -VIRGIN ISLANDS, U.S. WF -WALLIS AND FUTUNA EH -WESTERN SAHARA YE -YEMEN ZM -ZAMBIA ZW -ZIMBABWE More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| US | |
| AF | |
| AL | |
| DZ | |
| AS | |
| AD | |
| AO | |
| AI | |
| AQ | |
| AG | |
| AR | |
| AM | |
| AW | |
| AU | |
| AT | |
| AZ | |
| BS | |
| BH | |
| BD | |
| BB | |
| BY | |
| BE | |
| BZ | |
| BJ | |
| BM | |
| BT | |
| BO | |
| BA | |
| BW | |
| BV | |
| BR | |
| IO | |
| BN | |
| BG | |
| BF | |
| BI | |
| KH | |
| CM | |
| CA | |
| CV | |
| KY | |
| CF | |
| TD | |
| CL | |
| CN | |
| CX | |
| CC | |
| CO | |
| KM | |
| CG | |
| CD | |
| CK | |
| CR | |
| CI | |
| HR | |
| CU | |
| CY | |
| CZ | |
| DK | |
| DJ | |
| DM | |
| DO | |
| EC | |
| EG | |
| SV | |
| GQ | |
| ER | |
| EE | |
| ET | |
| FK | |
| FO | |
| FJ | |
| FI | |
| FR | |
| GF | |
| PF | |
| TF | |
| GA | |
| GM | |
| GE | |
| DE | |
| GH | |
| GI | |
| GR | |
| GL | |
| GD | |
| GP | |
| GU | |
| GT | |
| GN | |
| GW | |
| GY | |
| HT | |
| HM | |
| VA | |
| HN | |
| HK | |
| HU | |
| IS | |
| IN | |
| ID | |
| IR | |
| IQ | |
| IE | |
| IL | |
| IT | |
| JM | |
| JP | |
| JO | |
| KZ | |
| KE | |
| KI | |
| KP | |
| KR | |
| KW | |
| KG | |
| LA | |
| LV | |
| LB | |
| LS | |
| LR | |
| LY | |
| LI | |
| LT | |
| LU | |
| MO | |
| MK | |
| MG | |
| MW | |
| MY | |
| MV | |
| ML | |
| MT | |
| MH | |
| MQ | |
| MR | |
| MU | |
| YT | |
| MX | |
| FM | |
| MD | |
| MC | |
| MN | |
| MS | |
| MA | |
| MZ | |
| MM | |
| NA | |
| NR | |
| NP | |
| NL | |
| AN | |
| NC | |
| NZ | |
| NI | |
| NE | |
| NG | |
| NU | |
| NF | |
| MP | |
| NO | |
| OM | |
| PK | |
| PW | |
| PS | |
| PA | |
| PG | |
| PY | |
| PE | |
| PH | |
| PN | |
| PL | |
| PT | |
| PR | |
| QA | |
| RE | |
| RO | |
| RU | |
| RW | |
| SH | |
| KN | |
| LC | |
| PM | |
| VC | |
| WS | |
| SM | |
| ST | |
| SA | |
| SN | |
| CS | |
| SC | |
| SL | |
| SG | |
| SK | |
| SI | |
| SB | |
| SO | |
| ZA | |
| GS | |
| ES | |
| LK | |
| SD | |
| SR | |
| SJ | |
| SZ | |
| SE | |
| CH | |
| SY | |
| TW | |
| TJ | |
| TZ | |
| TH | |
| TL | |
| TG | |
| TK | |
| TO | |
| TT | |
| TN | |
| TR | |
| TM | |
| TC | |
| TV | |
| UG | |
| UA | |
| AE | |
| GB | |
| UM | |
| UY | |
| UZ | |
| VU | |
| VE | |
| VN | |
| VG | |
| VI | |
| WF | |
| EH | |
| YE | |
| ZM | |
| ZW |
| Super-types: | xsd:string < County (by restriction) |
|---|---|
| Sub-types: | None |
| Name | County |
|---|---|
| Documentation | Business party county location More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Currency (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Currency |
|---|---|
| Documentation | The ISO code identifying the type of currency in use. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| USD | |
| ADP | |
| AED | |
| AFA | |
| ALL | |
| ANG | |
| AOK | |
| ARA | |
| ATS | |
| AUD | |
| AWG | |
| BBD | |
| BDT | |
| BEF | |
| BGL | |
| BHD | |
| BIF | |
| BMD | |
| BND | |
| BOB | |
| BRC | |
| BSD | |
| BTN | |
| BUK | |
| BWP | |
| BZD | |
| CAD | |
| CHF | |
| CLF | |
| CLP | |
| CNY | |
| COP | |
| CRC | |
| CSK | |
| CUP | |
| CVE | |
| CYP | |
| DDM | |
| DEM | |
| DJF | |
| DKK | |
| DOP | |
| DZD | |
| ECS | |
| EGP | |
| ESP | |
| ETB | |
| EUR | |
| FIM | |
| FKP | |
| FRF | |
| GBP | |
| GHC | |
| GIP | |
| GMD | |
| GNF | |
| GRD | |
| GTQ | |
| GWP | |
| GYD | |
| HKD | |
| HNL | |
| HTG | |
| HUF | |
| IDR | |
| IEP | |
| ILS | |
| INR | |
| IQD | |
| IRR | |
| ISK | |
| ITL | |
| JMD | |
| JOD | |
| JPY | |
| KES | |
| KHR | |
| KMF | |
| KPW | |
| KRW | |
| KWD | |
| KYD | |
| LAK | |
| LBP | |
| LKR | |
| LRD | |
| LSL | |
| LUF | |
| LYD | |
| MAD | |
| MGF | |
| MNT | |
| MOP | |
| MRO | |
| MTL | |
| MUR | |
| MVR | |
| MWK | |
| MXN | |
| MYR | |
| MZM | |
| NGN | |
| NIC | |
| NLG | |
| NOK | |
| NPR | |
| NZD | |
| OMR | |
| PAB | |
| PEI | |
| PGK | |
| PHP | |
| PKR | |
| PLZ | |
| PTE | |
| PYG | |
| QAR | |
| ROL | |
| RWF | |
| SAR | |
| SBD | |
| SCR | |
| SDP | |
| SEK | |
| SGD | |
| SHP | |
| SLL | |
| SKK | |
| SOS | |
| SRG | |
| STD | |
| SUR | |
| SVC | |
| SYP | |
| SZL | |
| THB | |
| TND | |
| TOP | |
| TPE | |
| TRL | |
| TTD | |
| TWD | |
| TZS | |
| UGS | |
| UYP | |
| VEB | |
| VND | |
| VUV | |
| WST | |
| YDD | |
| YER | |
| YUD | |
| ZAR | |
| ZRZ | |
| ZWD | |
| Other |
| Super-types: | xsd:date < Date (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Date |
|---|---|
| Documentation | Date conforms to ISO 8601 format rules EX: \d\d\d\d-\d\d-\d\d More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) |
|---|---|
| Sub-types: |
|
| Name | DateTime |
|---|---|
| Documentation | Date and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < DealerName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerName |
|---|---|
| Documentation | Dealer name More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Department (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Department |
|---|---|
| Documentation | Department More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Department (by restriction) < DepartmentType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DepartmentType |
|---|---|
| Documentation | Identifies the type of department More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DistrictCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DistrictCode |
|---|---|
| Documentation | Manufacturer Assigned District Code More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DocumentDateTime |
|---|---|
| Documentation | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Expression (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Expression |
|---|
| Super-types: | xsd:string < ExpressionLanguage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpressionLanguage |
|---|
| Super-types: | xsd:string < Indicator (by restriction) < HazmatInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HazmatInd |
|---|---|
| Documentation | Indicator that Hazmat Was Used More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Indicator (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Indicator |
|---|---|
| Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Language (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Language |
|---|---|
| Documentation | Language conforms to ISO 639-2 rules. Note the format for this field is language-Country (see Country data type for the list of countries with definitions). AA "Afar", AB "Abkhazian", AF "Afrikaans", AM "Amharic", AR "Arabic", AS "Assamese", AY "Aymara", AZ "Azerbaijani", BA "Bashkir", BE "Byelorussian", BG "Bulgarian", BH "Bihari", BI "Bislama", BN "Bengali" "Bangla", BO "Tibetan", BR "Breton", CA "Catalan", CO "Corsican", CS "Czech", CY "Welsh", DA "Danish", DE "German", DZ "Bhutani", EL "Greek", EN "English" "American", ES "Spanish", ET "Estonian", EU "Basque", FA "Persian", FI "Finnish", FJ "Fiji", FO "Faeroese", FR "French", FY "Frisian", GA "Irish", GD "Gaelic" "Scots Gaelic", GL "Galician", GN "Guarani", GU "Gujarati", HA "Hausa", HI "Hindi", HR "Croatian", HU "Hungarian", HY "Armenian", IK "Inupiak", IN "Indonesian", IS "Icelandic", IT "Italian", IW "Hebrew", JA "Japanese", JI "Yiddish", JW "Javanese", KA "Georgian", KK "Kazakh", KL "Greenlandic", KM "Cambodian", KN "Kannada", KO "Korean", KS "Kashmiri", KU "Kurdish", KY "Kirghiz", LA "Latin", LN "Lingala", LO "Laothian", LT "Lithuanian", LV "Latvian" "Lettish", MG "Malagasy". MI "Maori", MK "Macedonian", ML "Malayalam", MN "Mongolian", MO "Moldavian", MR "Marathi", MS "Malay", MT "Maltese", MY "Burmese", NA "Nauru", NE "Nepali", NL "Dutch", NO "Norwegian", OC "Occitan", OM "Oromo" "Afan", OR "Oriya", PA "Punjabi", PL "Polish", PS "Pashto" "Pushto", PT "Portuguese", QU "Quechua", RM "Rhaeto-Romance", RN "Kirundi", RO "Romanian", RU "Russian", RW "Kinyarwanda", SA "Sanskrit", SD "Sindhi", SG "Sangro", SH "Serbo-Croatian", SI "Singhalese", SK "Slovak", SL "Slovenian", SM "Samoan", SN "Shona", SO "Somali", SQ "Albanian", SR "Serbian", SS "Siswati", ST "Sesotho", SU "Sudanese", SV "Swedish", SW "Swahili", TA "Tamil", TE "Tegulu", TG "Tajik", TH "Thai", TI "Tigrinya", TK "Turkmen", TL "Tagalog", TN "Setswana", TO "Tonga", TR "Turkish", TS "Tsonga", TT "Tatar", TW "Twi", UK "Ukrainian", UR "Urdu", UZ "Uzbek", VI "Vietnamese", WO "Wolof", XH "Xhosa", YO "Yoruba", ZH "Chinese", ZU "Zulu" More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| en-US | |
| en-CA | |
| aa-ET | |
| ab-GE | |
| af-ZA | |
| am- ET | |
| ar-SA | |
| as-IN | |
| ay-BO | |
| az-AZ | |
| ba-RU | |
| be-BY | |
| bg-BG | |
| bh-IN | |
| bi-VU | |
| bn-BD | |
| bo-BT | |
| br-FR | |
| ca-ES | |
| co-FR | |
| cs-CZ | |
| cy-GB | |
| da-DE | |
| de-DE | |
| dz-BT | |
| el-GR | |
| es-ES | |
| et-EE | |
| eu-ES | |
| fa-AF | |
| fi-FI | |
| fj-FJ | |
| fo-FO | |
| fr-CA | |
| fr-FR | |
| fy-NL | |
| ga-IE | |
| gd-GB | |
| gl-ES | |
| gn-PY | |
| gu-IN | |
| ha-NG | |
| hi-IN | |
| hr-HR | |
| hu-HU | |
| hy-AM | |
| ik-GL | |
| in-ID | |
| is-IS | |
| it-IT | |
| iw-IL | |
| ja-JP | |
| ji-IL | |
| jw-ID | |
| ka-GE | |
| kk-KZ | |
| kl-GL | |
| km-KH | |
| kn-IN | |
| ko-KP | |
| ko-KR | |
| ks-IN | |
| ku-IQ | |
| ky-CN | |
| la-VA | |
| ln-CD | |
| lo-LA | |
| lt-LT | |
| lv-LV | |
| mg-MG | |
| mi-NZ | |
| mk-MK | |
| ml-IN | |
| mn-MN | |
| mo-MO | |
| mr-IN | |
| ms-MY | |
| mt-MH | |
| my-MM | |
| na-NR | |
| ne-NP | |
| nl-NL | |
| no-NO | |
| oc-FR | |
| om- ET | |
| or-IN | |
| pa-IN | |
| pl-PL | |
| ps-PK | |
| pt-PT | |
| qu-PE | |
| rm-CH | |
| rn-BI | |
| ro-RO | |
| ru-RU | |
| rw-RW | |
| sa-IN | |
| sd-PK | |
| sg-CF | |
| sh-HR | |
| si-LK | |
| sk-SK | |
| sl-SI | |
| sm-WS | |
| sn-ZW | |
| so-SO | |
| sq-AL | |
| sr-CS | |
| ss-ZA | |
| st-ZA | |
| su-SD | |
| sv-SE | |
| sw-TL | |
| ta-IN | |
| te-IN | |
| tg-TJ | |
| th-TH | |
| ti-ET | |
| tk-TM | |
| tl-PH | |
| tn-ZA | |
| to-TO | |
| tr-TR | |
| ts-ZA | |
| tt-RU | |
| tw-GH | |
| uk-UA | |
| ur-PK | |
| uz-UZ | |
| vi-VN | |
| wo-SN | |
| xh-ZA | |
| yo-NG | |
| zh-CN | |
| zu-ZA |
| Super-types: | xsd:date < Date (by restriction) < LastInventoryDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LastInventoryDate |
|---|---|
| Documentation | The last date inventory was updated for this part. More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < LastSoldDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LastSoldDate |
|---|---|
| Documentation | Last date this item was sold. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < LineNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LineNumber |
|---|---|
| Documentation | The number of the given Line Component within the document. LineNumbers are assigned by the sending system. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < LocatorCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LocatorCode |
|---|---|
| Documentation | Identifies the type of locator transaction being performed. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Name |
|---|---|
| Documentation | Name of the Party. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Note |
|---|---|
| Documentation | A free form note. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < OrganizationName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrganizationName |
|---|---|
| Documentation | OrganizationName More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < PartClass (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartClass |
|---|---|
| Documentation | Gifts, literature, keys, regular parts Inventory Class code (if any) used in DMS system. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < PartType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartType |
|---|---|
| Documentation | Specifies whether the parts are indicated by manufacturer part code or Part Number - H = Manufacturer Part Code, P = Part Number More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| H | Manufacturer Part Code |
| P | "P" = Pending |
| Super-types: | xsd:string < Name (by restriction) < PartyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartyName |
|---|---|
| Documentation | The name of the Party. The Party in the context of a Parts Locator is either a dealer, OEM supplier, or aftermarket distributor. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < PartyType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartyType |
|---|---|
| Documentation | Identifies if the supplier is a dealer or a supplier (OEM or aftermarket distributor). More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Supplier | OEM or aftermarket distributor |
| Dealer | Dealer |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Code (by restriction) < PostalCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PostalCode |
|---|---|
| Documentation | Postal Code of the Address. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < PreferredContactMethodOrganization (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PreferredContactMethodOrganization |
|---|---|
| Documentation | Preferred Contact Method Organization More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Day Phone | Day Phone |
| Cell Phone | Cell Phone |
| Work Fax | Work Fax |
| Pager | Pager |
| Work Email | Work Email |
| US Mail | US Mail |
| Other | Other |
| Super-types: | xsd:string < Note (by restriction) < PriceExplanation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PriceExplanation |
|---|---|
| Documentation | Explanatory Note for Pricing More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Reference |
|---|---|
| Documentation | Reference notation More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) |
|---|---|
| Sub-types: |
|
| Name | ReferenceNumber |
|---|---|
| Documentation | Reference number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < RequestedSearchCriteriaType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RequestedSearchCriteriaType |
|---|---|
| Documentation | Defines whether the search applies to Dealers, Suppliers or both Dealers and Suppliers. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Dealer | Dealer |
| Supplier | OEM or aftermarket distributor |
| Dealer And Supplier | Searching dealers and suppliers |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Name (by restriction) < SalesPersonName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SalesPersonName |
|---|---|
| Documentation | Name of Salesperson. Format for name should be "First Last" with no commas between first and last name More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < SecondaryPassword (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SecondaryPassword |
|---|---|
| Documentation | Secondary password used to validate access to the dealer information More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < SelectionMethod (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SelectionMethod |
|---|---|
| Documentation | Method used to select dealer Example: PF for preferred, PM for PMA, DI for distance, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShortMfg |
|---|---|
| Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StateOrProvince (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StateOrProvince |
|---|---|
| Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StatusCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusCode |
|---|---|
| Documentation | A code identifying the reason for the status message. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Success | The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success. |
| Unspecified | An unspecified error occurred. The StatusText field contains the complete text. |
| Not In Inventory | Inventory is not currently available and back ordering was not requested. |
| Discontinued | The part has discontinued. |
| Invalid Part | Invalid part number. |
| Not Yet Available | The part is scheduled for a future release date and is not available at this time. |
| Not Authorized | The part is not authorized for your product line. |
| Under Development | The part is under development and not ready for sale. |
| Assembly Only | The part is a component part and is only available as an assembly. |
| Component Only | The part is an assembly part and is only available as a component. |
| Internal Use Only | The part is reserved for manufacturing and supplier internal use; it is not a service replacement part. |
| Recalled | The part has been recalled. |
| Cannot Sell | The part is not available for sale for an unspecified reason. |
| Export Only | The part is not available for sale in the United States; it is for export vehicles only. |
| Credit Limit Exceeded | Credit limit exceeded. |
| Credit Card Denied | Credit card transaction denied by creditor. |
| Account On Hold | The dealer's account has been put on hold. |
| Invalid Unit Of Measure | The unit of measurement was invalid for this part number. |
| Invalid Promotion Code | The promotion code is invalid. |
| Invalid Shipping Method | The shipping method is invalid, for example, shipping by ground to Puerto Rico. |
| Duplicate Line Number | The line number is the same as another line within this transaction. |
| No Drop Shipment | Drop shipments are not allowed. |
| No Will Call | Will-call pickups are not allowed. |
| Minimum Quantity Not Met | There is a minimum quantity purchase requirement for this part and the quantity has not been met. The minimum quantity is: NN |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Text (by restriction) < StatusText (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusText |
|---|---|
| Documentation | Descriptive status text. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StatusType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusType |
|---|---|
| Documentation | Defines the type of status that occurred. EX: S-Success, E-Error, I-Info, A-Abort More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Success | The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success. |
| Error | The operation resulted in error and did not succeed. |
| Warning | The operation completed a warning. |
| Informational | The provided StatusText is informational. |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SystemVersion |
|---|---|
| Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < UOM (by restriction) |
|---|---|
| Sub-types: | None |
| Name | UOM |
|---|---|
| Documentation | Units of Measure - ea=Each; bx=Box; case=Case; ctn=Carton; gal=Gallon; qt=Quart; pt=Pint; ft=Feet; yd=Yard; in=Inch; L=Liter; m=Meter; cm=Centimeter; kg=Kilograms; g=grams; other=Other More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| ea | Each |
| bx | Box |
| case | Case |
| ctn | Carton |
| gal | Gallon |
| qt | Quart |
| pt | Pint |
| ft | ft = feet |
| yd | yd = yard |
| in | in = inch |
| L | "L" = Canceled |
| m | m = meter |
| cm | cm = centimeter |
| kg | Kilogram |
| g | Gram |
| other | |
| tn | Ton |
| km | kilometers |
| mi | miles |
| hp | horsepower |
| kw | kilowatt |
| Super-types: | xsd:string < Code (by restriction) < UrbanizationCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | UrbanizationCode |
|---|---|
| Documentation | Geographic definition of a metropolitan or suburban area More information at: http://www.starstandard.org. |
| Super-types: | xsd:anyURI < URI (by restriction) |
|---|---|
| Sub-types: | None |
| Name | URI |
|---|---|
| Documentation | URI More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ZoneCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ZoneCode |
|---|---|
| Documentation | Manufacturer Assigned Zone Code More information at: http://www.starstandard.org. |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: