Implementation Guideline
Process Parts Shipment
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Process Parts Shipment
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 Process Parts Shipment Business Object Document (BOD). Process Parts Shipment has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Process Parts Shipment 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 Process Parts Shipment, this BOD could be used to send Process Parts Shipment information between any two business parties.
The Process Parts Shipment Implementation Guidelines provide detailed information regarding the structure and meaning of the Process Parts Shipment BOD and corresponds directly to the Process Parts Shipment 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 Process Parts Shipment Implementation Guidelines must be used in concert with the Process Parts Shipment 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 Process Parts Shipment 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 Process Parts Shipment BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Process Parts Shipment 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 Process Parts Shipment 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 Shipment Binary Collaboration is a push of a Parts Shipment from the OEM to the Dealer. (i.e., the OEM sends a Parts Shipment (Process Parts Shipment) BOD to the Dealer.) Note: This scenario is an example of how the Parts Shipment BOD can be used. Implementations may vary.
The relationship diagram identifies all of the various components or building blocks of information used in the Process Parts Shipment 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 |
| 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 | Header |
|---|---|
| Type | PartsShipmentHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Line |
|---|---|
| Type | PartsShipmentLine |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | PartsShipment |
|---|---|
| Type | PartsShipment |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Process |
|---|---|
| Type | Process |
| Nillable | no |
| Abstract | no |
| Documentation | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. More information at: http://www.openapplications.org/oagis. |
| Name | ProcessPartsShipment |
|---|---|
| Type | ProcessPartsShipment |
| Nillable | no |
| Abstract | no |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | xsd:decimal < Amount (by extension) < AccessoriesDiscountAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | AccessoriesDiscountAmount |
|---|---|
| Abstract | no |
| Documentation | Discount Amount for accessories only More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) < AcknowledgableVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | AcknowledgableVerb |
|---|---|
| Abstract | yes |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| acknowledge | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ActionExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Expression | Required |
| Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | ActionVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| 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 | |
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | AlternatePartyId |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required |
| 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 |
Optional. "qualifyingAgency" attribute.
|
| 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: | xsd:decimal < Quantity (by extension) < BackOrderQuantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | BackOrderQuantity |
|---|---|
| Abstract | no |
| Documentation | Quantity of part on back order More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Boxing |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| TotalCartons | Sum of the total cartons | Optional | |
| TotalVolume | Total volume | Optional | |
| TotalNetWeight | Total net weight | Optional | |
| TotalGrossWeight | Total Gross Weight | Optional | |
| BoxingDetail | Detailed boxing information | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | BoxingDetail |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| CasePacking | Type of cartons or cases the material is packed in (e.g., triple wall cardboard) | Optional | |
| PalletBoxNumber | Box number on pallet | Optional | |
| Volume | Volume | Optional | |
| NetWeight | Net Weight | Optional | |
| GrossWeight | Gross Weight | Optional | |
| BoxTrackingNumber | The tracking number for the individual box as given by the ShipCarrier. | Optional | |
| ETADateTime | The date and time the box is expected to arrive. This is a box level override to Header ETADateTime. | Optional | |
| ShipPriority | Defines the shipping method and shipping duration for the box. This is a box level override to Header ShipPriority | Optional |
| 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) < CoreUnitAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | CoreUnitAmount |
|---|---|
| Abstract | no |
| Documentation | Core value per unit. More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) |
|---|---|
| Sub-types: | None |
| Name | Count |
|---|---|
| Abstract | no |
| Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
| 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:decimal < Percent (by extension) < DiscountPercentage (by extension) |
|---|---|
| Sub-types: | None |
| Name | DiscountPercentage |
|---|---|
| Abstract | no |
| Documentation | Percentage of discount. More information at: http://www.starstandard.org. |
| 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: | xsd:decimal < Amount (by extension) < ExtendedCoreAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ExtendedCoreAmount |
|---|---|
| Abstract | no |
| Documentation | Total core value More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < ItemId (by extension) < FormerPartNumber (by extension) |
|---|---|
| Sub-types: | None |
| Name | FormerPartNumber |
|---|---|
| Abstract | no |
| Documentation | Former part number of substitution or replacement More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Weight (by extension) < GrossWeight (by extension) |
|---|---|
| Sub-types: | None |
| Name | GrossWeight |
|---|---|
| Abstract | no |
| Documentation | Gross Weight More information at: http://www.starstandard.org. |
| 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 |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets. EX:
2003-11-05T13:15:30Z
|
| 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:decimal < Amount (by extension) < HTSAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | HTSAmount |
|---|---|
| Abstract | no |
| Documentation | Total dollar value per harmonized tariff schedule More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | HTSSummary |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| HTSSummarySchedule | Harmonized Tariff Schedule (HTS) used in Invoice/Shipment | Optional | |
| HTSAmount | Total dollar value per harmonized tariff schedule | Optional | |
| HTSUnitsQuantity | Total pieces per harmonized tariff schedule | Optional |
| Super-types: | xsd:integer < Count (by extension) < HTSUnitsQuantity (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HTSUnitsQuantity |
|---|---|
| Abstract | no |
| Documentation | Total number of persons in household including children More information at: http://www.starstandard.org. |
| 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:decimal < Amount (by extension) < ImportPermitAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ImportPermitAmount |
|---|---|
| Abstract | no |
| Documentation | Dollar value of import permit 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: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:decimal < Weight (by extension) < NetWeight (by extension) |
|---|---|
| Sub-types: | None |
| Name | NetWeight |
|---|---|
| Abstract | no |
| Documentation | Net Weight More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < NonTaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | NonTaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total non-taxable price. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < OrderQuantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrderQuantity |
|---|---|
| Abstract | no |
| Documentation | Indicates the number of ordered items. More information at: http://www.starstandard.org. |
| 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 | |
| Country | Country in which the Address is in. | Required | |
| PostalCode | Postal Code of the Address. | Required | |
| UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
| Super-types: | AlternatePartyId < OrganizationalPartyAlternatePartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationalPartyAlternatePartyId |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required | |
| AssigningPartyId | Agency or entity that validates the Party Id | Required | |
| IssuingState | Indicates that State where the license was issued. | Optional | |
| ExpirationDate | Expiration date of the alternate party id (e.g., Driver's License expiration date). | Optional |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | OrganizationPartyBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < OtherDiscountAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | OtherDiscountAmount |
|---|---|
| Abstract | no |
| Documentation | Discount amount for miscellaneous only 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 | PartsShipment |
|---|---|
| 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 01/10/2003; OAGI approved 3/15/2003; effective date 01/01/2003 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| Line | Required |
| Super-types: | HeaderBase < PartsShipmentHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartsShipmentHeader |
|---|---|
| Abstract | no |
| 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 |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets. EX:
2003-11-05T13:15:30Z
|
| 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 | Manufacturer-assigned shipment number given at the time of shipment | Optional | |
| TransactionType | Shipment type | Optional | |
| ShipDate | Parts shipping date | Optional | In YYYY-MM-DD format. |
| ReferenceNumber | Dealer-assigned order number for this Shipment | Optional | |
| ShipmentCarrier | Carrier used for delivery of part order | Optional | |
| PDC | Dealer’s regular Parts Distribution Center (PDC) | Optional | |
| ShippingPDC | Parts Distribution Center (PDC) for this shipment. | Optional | |
| TotalPartPieces | Sum of all pieces in all parts in the Shipment | Optional | |
| ProcessDate | Pick and pack date of order/shipment | Optional | In YYYY-MM-DD format. |
| AccessoriesDiscountAmount | Discount Amount for accessories only | Optional | |
| OtherDiscountAmount | Discount amount for miscellaneous only. | Optional | |
| TotalDiscountAmount | Total discounts | Optional | |
| Tax | Tax information associated with the Shipment | Optional | Values: Total |
| TotalAmount | Grand total of Shipment | Optional | |
| SalesPromotionCode | Sales promotion code on invoice, if any. | Optional | |
| ProcessCode | Code designating how the order was shipped (i.e., Overnight). | Optional | |
| ManufacturerOrderNumber | Manufacturer-assigned order number | Optional | |
| ETADateTime | Estimated date and time the shipment is expected to arrive | Optional |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets. EX:
2003-11-05T13:15:30Z
|
| FOBTerms | Transit Ownership terms | Optional | |
| FreightTerms | Designates who pays freight - - Collect / Prepaid | Optional | |
| ShipTo | Ship To | Optional | |
| HTSSummary | Harmonized Tariff Schedule Summary | Optional | |
| Boxing | Shipment Boxing | Optional | |
| PartsShipmentLineBoxingType | Identifies how the BOD is intended to be interpreted by the receiver. Specifically, indicates whether boxing detail is present and, if so, whether each Line item in the shipment is within a specific box. | Optional | |
| ShipPriority | Defines the shipping method and shipping duration. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | PartsShipmentLine |
|---|---|
| Abstract | no |
| Documentation | . More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LineNumber | This references the line in the Invoice document. Item designator other than part number (i.e., line item number of the order/shipment) | Optional | |
| ShipmentNumber | Manufacturer-assigned shipment number given at the time of shipment | Optional | |
| Item | Information about the item | Optional | |
| OrderQuantity | Quantity of part ordered | Optional | |
| BackOrderQuantity | Quantity of part on back order | Optional | |
| QuantityShipped | Quantity of part shipped | Optional | |
| UnitPack | Package quantity of part (number of units in each selling package) | Optional | |
| PartDimensions | Indicates the dimensions of a part, such as the length and width of a piece of cloth or leather | Optional | |
| FormerPartNumber | Former part number of substitution or replacement | Optional | |
| PartCountry | Indicates part country name or country code | Optional | |
| Price | Information about the item | Optional | |
| OrderReferenceNumber | Original order number for line item | Optional | |
| DiscountCode | Discount or pricing code | Optional | |
| DiscountPercentage | Percentage of discount. | Optional | |
| TaxInd | Indicates whether or not tax applies to part | Optional | |
| Tax | Tax information associated with the line | Optional | |
| ReturnReasonCode | Designates the reason the line item part was returned (i.e., shortage, error, quality problem, cores return, obsolete, etc.) | Optional | |
| RestockCode | Code for restocking item (i.e., manufacturer product division) | Optional | |
| ProcessDate | Pick and pack date of individual line item in order/shipment | Optional | |
| SalesPromotionCode | Sales promotion code on invoice/shipment for the line item if different from the header promotion code | Optional | |
| ProcessCode | Code designating how the line item on the order was shipped if different from header process code | Optional | |
| InventoryMovementDemandCode | Code designating the inventory rate at which item turns (e.g., A, B, C, etc.) | Optional | |
| MiscellaneousNotes | Free form miscellaneous comments | Optional | |
| ManufacturerOrderNumber | Manufacturer-assigned order number | Optional | |
| HTSCode | Harmonized tariff schedule code | Optional | |
| HazmatInd | Indicates whether this part the dealer is ordering is considered a Hazardous Material (e.g., air bag) | Optional | |
| TotalSubjectToDutyAmount | Subtotal including discount less core | Optional | |
| ExtendedCoreAmount | Total core value | Optional | |
| CoreUnitAmount | Core value per unit. | Optional | |
| ETADate | Estimated time the shipment is expected to arrive | Optional | |
| ConveyanceNumber | Shipping container number | Optional | |
| CaseMarks | Free form text for mandatory case identification | Optional | |
| CaseCartonNumber | Case number in shipment | Optional | |
| RackContainerType | Type of rack or container used to hold parts, boxes, cases, etc | Optional | |
| RackContainerQuantity | Identifies the quantity count of racks or containers | Optional | |
| RackContainerNumber | Number of rack or container – may be serialized. | Optional | |
| RackContainerDeposit | Deposit amount for a Rack or Container | Optional | |
| ETADateTime | Estimated date and time the shipment is expected to arrive | Optional | |
| ShipPriority | The parts shipping priority. Used as a line level overrideto the ShipPriority in the Header. | Optional | |
| OrderLineNumber | The line number of the dealer’s order identified by OrderReferenceNumber for which Item identifies the part as being shipped. | 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:string < Description (by extension) < PDC (by extension) |
|---|---|
| Sub-types: | None |
| Name | PDC |
|---|---|
| Abstract | no |
| Documentation | Parts distribution center. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) |
|---|---|
| Sub-types: | None |
| Name | Percent |
|---|---|
| Abstract | no |
| Documentation | Percent More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | Price |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PriceType | Identifies the price type | Required | |
| TaxableAmount | Total Taxable Price | Optional | |
| NonTaxableAmount | Total non-taxable price. | Optional | |
| TotalAmount | Total price (cost + markup) | Optional | |
| UnitPrice | UnitPrice | Optional | |
| TotalCost | Value at unit cost times quantity | Optional | |
| UnitCost | Cost at inventory value | Optional | |
| PriceExplanation | Explanatory Note for Pricing | Optional |
| Super-types: | Verb < ConfirmableVerb (by extension) < ActionVerb (by extension) < AcknowledgableVerb (by extension) < Process (by extension) |
|---|---|
| Sub-types: | None |
| Name | Process |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| Criteria | Optional |
| Super-types: | BusinessObjectDocument < ProcessPartsShipment (by extension) |
|---|---|
| Sub-types: | None |
| Name | ProcessPartsShipment |
|---|---|
| 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 | ProcessPartsShipmentDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Process | The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowlegdes with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfil the agreement, unless of course other BODs are allowed to cancel or change the original order. | Required | |
| PartsShipment | Required |
| 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: | xsd:decimal < Quantity (by extension) < QuantityShipped (by extension) |
|---|---|
| Sub-types: | None |
| Name | QuantityShipped |
|---|---|
| Abstract | no |
| Documentation | The quantity shipped More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < RackContainerDeposit (by extension) |
|---|---|
| Sub-types: | None |
| Name | RackContainerDeposit |
|---|---|
| Abstract | no |
| Documentation | Deposit amount for a Rack or Container More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < RackContainerQuantity (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RackContainerQuantity |
|---|---|
| Abstract | no |
| Documentation | Identifies the quantity count of racks or containers More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < ReturnReasonCode (by extension) |
|---|---|
| Sub-types: | None |
| Name | ReturnReasonCode |
|---|---|
| Abstract | no |
| Documentation | Designates the reason the line item part was returned (i.e., shortage, error, quality problem, cores return, obsolete, etc.). 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 |
Dealer Number is Required if originating from DMS.
|
| 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 |
1 - Receive Pending Mail. 0 - Do not receive pending
mail.
|
| 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: | xsd:string < Description (by extension) < ShippingPDC (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShippingPDC |
|---|---|
| Abstract | no |
| Documentation | Parts Distribution Center (PDC) for shipment More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < ShipToParty (by extension) |
|---|---|
| Sub-types: |
|
| Name | ShipToParty |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| LocationId | Code identifying the physical location of a dealer. | Optional |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < ShipToParty (by extension) < ShipToPartyPermit (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShipToPartyPermit |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| LocationId | Code identifying the physical location of a dealer. | Optional | |
| ImporterOfRecordNumber | Import license number. | Optional | |
| LicenseExpirationDate | Expiration date of import permit | Optional | |
| ImportPermitAmount | Dollar value of import permit. | 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: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 | Tax |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| TaxType | Identifies the type tax. | Required | Values: Amount, Total |
| TaxDescription | Free form text description of tax amount. | Optional | |
| TaxAmount | Actual amount of tax paid. | Optional | |
| UnitSalesTaxAmount | Unit amount of sales tax. | Optional | |
| TaxRate | Tax Percentage Rate | Optional | |
| TotalTaxableAmount | Total taxble price | Optional | |
| NonTaxableAmount | Total non-taxble price | Optional | |
| TaxTypeId | Tax type identification | Optional | |
| TaxabilityInd | Determines whether the dealer wants to claim tax on the cost. | Optional |
Values: 1 - Yes. 0 - No. Note this should be part of
the enumerated value description.
|
| Super-types: | xsd:decimal < Amount (by extension) < TaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total Taxable Price More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxAmount |
|---|---|
| Abstract | no |
| Documentation | Actual amount of tax paid. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < TaxDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxDescription |
|---|---|
| Abstract | no |
| Documentation | Free form text description of tax amount. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < TaxRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxRate |
|---|---|
| Abstract | no |
| Documentation | Tax Percentage rate. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalAmount |
|---|---|
| Abstract | no |
| Documentation | Total price (cost + markup) More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < TotalCartons (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TotalCartons |
|---|---|
| Abstract | no |
| Documentation | Sum of the total cartons More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalCost (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalCost |
|---|---|
| Abstract | no |
| Documentation | Value at unit cost times quantity More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalDiscountAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalDiscountAmount |
|---|---|
| Abstract | no |
| Documentation | Total discounts More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Weight (by extension) < TotalGrossWeight (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalGrossWeight |
|---|---|
| Abstract | no |
| Documentation | Total Gross Weight More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Weight (by extension) < TotalNetWeight (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalNetWeight |
|---|---|
| Abstract | no |
| Documentation | Total Net Weight More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < TotalPartPieces (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalPartPieces |
|---|---|
| Abstract | no |
| Documentation | The total number of part pieces to be contained in the transaction. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalSubjectToDutyAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalSubjectToDutyAmount |
|---|---|
| Abstract | no |
| Documentation | Total Subject To Duty Amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalTaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalTaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total taxable price. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Volume (by extension) < TotalVolume (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalVolume |
|---|---|
| Abstract | no |
| Documentation | Total volume More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < UnitCost (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitCost |
|---|---|
| Abstract | no |
| Documentation | Cost at inventory value More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < UnitPack (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitPack |
|---|---|
| Abstract | no |
| Documentation | Quantity of items sold as one unit. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < UnitPrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitPrice |
|---|---|
| Abstract | no |
| Documentation | UnitPrice More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < UnitSalesTaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitSalesTaxAmount |
|---|---|
| Abstract | no |
| Documentation | Unit amount of sales tax. 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:decimal < Volume (by extension) |
|---|---|
| Sub-types: | None |
| Name | Volume |
|---|---|
| Abstract | no |
| Documentation | Volume measurement More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Required |
| Super-types: | xsd:decimal < Weight (by extension) |
|---|---|
| Sub-types: | None |
| Name | Weight |
|---|---|
| Abstract | no |
| Documentation | Weight measurement More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Required |
| Super-types: | xsd:NMTOKEN < AcknowledgementType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AcknowledgementType |
|---|
| Code Value | Description |
|---|---|
| Always | |
| OnChange | |
| Never |
| Super-types: | xsd:string < Action (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Action |
|---|
| Code Value | Description |
|---|---|
| Add | |
| Delete | |
| Change | |
| Replace | |
| A | |
| D | |
| C | |
| R |
| 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 < AssigningOrganizationPartyId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AssigningOrganizationPartyId |
|---|---|
| Documentation | Assigning Organization Party Id More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| LegalId | Legal ID |
| NationalId | Government-assigned ID such as a social security Number |
| Other | Other |
| DUNS | Dun and Bradstreet |
| MotorDealerRegistrationId | Department of Motor Vehicle Registration number for a dealer. This is the dealer's license number to do business. |
| GSTRegistrationId | Canadian Goods and Services Tax Id. |
| HSTRegistrationId | Canadian HarmonizedTax Id. |
| Certification Of Registration Id | Id of the certificate of registration assigned to a business to allow that business to collect and remit certain taxes or fees to a state. |
| QSTRegistrationId | Quebec sales tax id. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < BoxTrackingNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BoxTrackingNumber |
|---|---|
| Documentation | The tracking number for the individual box as given by the ShipCarrier. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < CaseCartonNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CaseCartonNumber |
|---|---|
| Documentation | Case number in shipment More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < CaseMarks (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CaseMarks |
|---|---|
| Documentation | Case number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < CasePacking (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CasePacking |
|---|---|
| Documentation | Type of cartons or cases the material is packed in (e.g., triple wall cardboard) More information at: http://www.starstandard.org. |
| 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:string < Name (by restriction) < CompanyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CompanyName |
|---|---|
| Documentation | Company name of customer 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 < ReferenceNumber (by restriction) < ConveyanceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ConveyanceNumber |
|---|---|
| Documentation | Shipping container number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Country (by restriction) |
|---|---|
| Sub-types: |
|
| 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) < DBAName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DBAName |
|---|---|
| Documentation | Doing Business As name. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DiscountCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DiscountCode |
|---|---|
| Documentation | Discount or Pricing 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:date < Date (by restriction) < ETADate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ETADate |
|---|---|
| Documentation | Estimated time of arrival More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) < ETADateTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ETADateTime |
|---|---|
| Documentation | Estimated time and time of arrival More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ExpirationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpirationDate |
|---|---|
| Documentation | Expiration Date 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 < Terms (by restriction) < FOBTerms (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FOBTerms |
|---|---|
| Documentation | Transit Ownership terms More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Terms (by restriction) < FreightTerms (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FreightTerms |
|---|---|
| Documentation | Designates who pays freight - - Collect / Prepaid More information at: http://www.starstandard.org. |
| 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 < Code (by restriction) < HTSCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HTSCode |
|---|---|
| Documentation | Harmonized tariff schedule code More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < HTSSummarySchedule (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HTSSummarySchedule |
|---|---|
| Documentation | HTS Summary schedule More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < ImporterOfRecordNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ImporterOfRecordNumber |
|---|---|
| Documentation | Import license number More information at: http://www.starstandard.org. |
| 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 < Code (by restriction) < InventoryMovementDemandCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InventoryMovementDemandCode |
|---|---|
| Documentation | Code designating the inventory rate at which item turns (e.g., A, B, C, etc.) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < InvoiceShipment (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InvoiceShipment |
|---|---|
| Documentation | Designates type of Invoice or shipment More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Credit | |
| History | |
| Retail | |
| Return | |
| Wholesale | |
| Shipment | |
| Other | Other |
| Super-types: | xsd:string < StateOrProvince (by restriction) < IssuingState (by restriction) |
|---|---|
| Sub-types: | None |
| Name | IssuingState |
|---|---|
| Documentation | Indicates that State where the license was issued. More information at: http://www.starstandard.org. |
| 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) < LicenseExpirationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LicenseExpirationDate |
|---|---|
| Documentation | Expiration date of license More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < LineNumber (by restriction) |
|---|---|
| Sub-types: |
|
| 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 < ReferenceNumber (by restriction) < ManufacturerOrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ManufacturerOrderNumber |
|---|---|
| Documentation | Manufacturer Order Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < MiscellaneousNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MiscellaneousNotes |
|---|---|
| Documentation | Free form miscellaneous comments 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 < ReferenceNumber (by restriction) < LineNumber (by restriction) < OrderLineNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderLineNumber |
|---|---|
| Documentation | The line number of the dealer's order identified by Line.OrderReferenceNumber for which Line.Item identifies the part as being shipped. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < OrderReferenceNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderReferenceNumber |
|---|---|
| Documentation | Original order number for line item. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < PalletBoxNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PalletBoxNumber |
|---|---|
| Documentation | Box number on pallet 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 < Country (by restriction) < PartCountry (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartCountry |
|---|---|
| Documentation | Part Country 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 < Note (by restriction) < PartDimensions (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartDimensions |
|---|---|
| Documentation | Indicates the dimensions of a part, such as the length and width of a piece of cloth or leather. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < PartsShipmentLineBoxingType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PartsShipmentLineBoxingType |
|---|---|
| Documentation | Identifies how the BOD is intended to be interpreted by the receiver. Specifically, indicates whether boxing detail is present and, if so, whether each Line item in the shipment is within a specific box. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Line Boxing Detail | Each line is associated with a specific box in the shipment. This provides a complete picture of what part is contained in which box. |
| Line Boxing Aggregate | Lines and Boxing data is available, however there is no detail as to which parts are contained in which boxes. The line data is aggregate. |
| Line Aggregate | There is no boxing detail provided and the line data is in aggregate for the shipment. |
| 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 < 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 < 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 < PriceType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PriceType |
|---|---|
| Documentation | Price Type More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Job | |
| Labor | |
| Parts | |
| Sublet | |
| Miscellaneous | |
| GasOilGrease | |
| PaintMaterials | |
| ShopSupplies | |
| Freight | |
| Claim | |
| SubletLabor | |
| SubletParts | |
| ReturnCore | |
| Customer | Initiative applies to Customer category, e.g. First Time Buyer, etc. |
| Internal | |
| RentLoaner | |
| Return | |
| Splits | |
| Total | |
| Other | Other |
| Super-types: | xsd:string < Code (by restriction) < ProcessCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ProcessCode |
|---|---|
| Documentation | Code designating how the order was processed More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ProcessDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ProcessDate |
|---|---|
| Documentation | Effective date of process More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < RackContainerNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RackContainerNumber |
|---|---|
| Documentation | Number of rack or container More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < RackContainerType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RackContainerType |
|---|---|
| Documentation | Type of rack or container used to hold parts, boxes, cases, etc 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 < Code (by restriction) < RestockCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RestockCode |
|---|---|
| Documentation | Code for restocking item (i.e., manufacturer product division). More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < SalesPromotionCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SalesPromotionCode |
|---|---|
| Documentation | Sales promotion code 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:date < Date (by restriction) < ShipDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShipDate |
|---|---|
| Documentation | Ship Date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ShipmentCarrier (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShipmentCarrier |
|---|---|
| Documentation | Preferred carrier of deliver of part. Fedex - FED, Air Contact Transport - ACT, Danzas - DAN, Yellow Freight - YFT, UPS - UPS, Motor Cargo - MTC, Averitt - AVE, Chopper - CHO, Command - COM, Other - OTH, N/A - N/A, United States Postal Service - USPS, DHL - DHL, CON - California Overnight More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| FED | Fedex |
| ACT | Air Contact Transport |
| DAN | Danzas |
| YFT | Yellow Freight |
| UPS | UPS |
| MTC | Motor Cargo |
| AVE | Averitt |
| CHO | Chopper |
| COM | Command |
| OTH | Other |
| N/A | Not Applicable |
| USPS | United States Postal Service |
| DHL | DHL |
| CON | California Overnight |
| Burl | Burlington Ontario |
| 7ALQ Alliance Shipping | 7ALQ Alliance Shipping |
| Roadway Express | Roadway Express |
| Parker Motor Freight | Parker Motor Freight |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < ShipmentNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShipmentNumber |
|---|---|
| Documentation | Number assigned to shipment. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ShipPriority (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShipPriority |
|---|---|
| Documentation | Defines two concepts: The shipping methd (e.g. ground or air) and the ship duration (how fast the customer wants the order to be deelivered. ShipPriority applies to all warehouse items can be shipped from, unless the supplier accepts an AlternatShipPriority. If the supplier accepts AlternateShipPriority, then ShipPriority applies only to the facing warehouse for the dealer. A facing warehouse is the default, usually the most geographically close, warehouse for the dealer. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Air Delivery | |
| 2nd Day Delivery | |
| Saturday Delivery | |
| Next Day Delivery by Air | |
| Surface By Noon Delivery | |
| Surface 12-3pm Delivery | |
| Surface 3-5pm Delivery | |
| Pickup Noon | |
| Pickup 12-3pm | |
| Pickup 3-5pm | |
| Next Day Delivery | |
| Surface | |
| Will Call | |
| Air Freight Collect | |
| Fastest Way | |
| Best Surface | |
| Other | Other |
| N/A | Not Applicable |
| Prearranged Shipping Terms | |
| Next Day AM | |
| Next Day PM | |
| Second Day AM | |
| Second Day PM | |
| Third Day | |
| Next Day Saturday | |
| Air Deferred | |
| Ship The Best Way |
| 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: |
|
| Name | StateOrProvince |
|---|---|
| Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
| 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 < Indicator (by restriction) < TaxabilityInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxabilityInd |
|---|---|
| Documentation | Determines whether an item or amount is taxable. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Indicator (by restriction) < TaxInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxInd |
|---|---|
| Documentation | Indicates whether or not tax applies More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < TaxType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxType |
|---|---|
| Documentation | Tax Type More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Total | |
| Amount | |
| Labor | |
| Parts | |
| Claim | |
| Dealer | Dealer |
| Deductible | |
| Prorated | |
| Other | Other |
| Luxury | |
| Vehicle Inventory | |
| Taxes Not In Cash Price | |
| Document Stamp | |
| Sales | |
| Tire | |
| Personal Property | |
| Registration | |
| Monthly/Use | |
| Weight | |
| Adjustment | |
| DownPayment | |
| CapCostReduction | |
| Lieu | |
| CurrentYear | |
| N/A | Not Applicable |
| LocalOption | Tennessee Tax - combination of city and county. |
| SingleArticle | Tennessee Tax - State Tax |
| Gas | Gas tax levied to applicable vehicles or by state/province law. (Referred to in US as "Gas Guzzler" tax). |
| Total Monthly/Use | The total amount of monthly use tax for a payment on a contract. |
| Service Contract | Tax charged on service contracts (where applicable). |
| Adjusted Sales | Adjusted sales tax due to tax modifications when capitalized (i.e. NY) |
| Total Sales/Use | The total amount of sales/use tax for a single payment contract. |
| Air Conditioning Excise | Provincal tax providing for the installation or removal of freon. (Canada) |
| Purchase and Use | A type of tax that is assessed upon "tax free" tangible personal property purchased by a resident of the assessing state for use, storage or consumption of goods in that state (not for resale), regardless of where the purchase took place. The tax is a one time retail tax due at registration or titling of a vehicle. |
| County Tax | A county tax charged based on the location of the dealer and the customer. An example, The Cook County Tax. |
| General Excise | This is a general excise tax that a state or region could impose. |
| Gross Receipt | A gross receipts tax, sometimes referred to as a gross excise tax, is a tax on the total gross revenues of a company, regardless of their source. |
| Tax on Trade-In | Tax due on a trade-in vehicle. |
| Tax on Upfront Fees | Total tax due on fees paid upfront. |
| Tax on Acquisition Fee | Tax due on amount of acquisition fee. |
| Environmental Tax | Environmental Levy / Tax. |
| Motor Vehicle Tax | Tax paid at of registration based on the vehicle's age and MSRP. |
| Wheel Tax | A tax levied by cities and villages to be credited to a road fund of the city or village |
| Super-types: | xsd:string < TaxTypeId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxTypeId |
|---|---|
| Documentation | CS - City, CP - County, ST - State, OT - Other, EX - Excise, VAT - Value Added Tax, PST - Provincial Sales Tax , RT - Rental, GST - Goods and Services Tax, HST - Harmonized Tax, ART - Air Tax, QST - Quebec Sales Tax, IMP - Import Tax More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| CS | City |
| CP | County |
| ST | State |
| OT | "OT" = Other |
| EX | Excise |
| VAT | Value Added |
| PST | Provincial Sales Tax |
| RT | Rental |
| GST | Goods and Services Tax |
| HST | Harmonized Tax |
| ART | Air Tax |
| QST | Quebec Sales Tax |
| IMP | Import Tax |
| Super-types: | xsd:string < Terms (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Terms |
|---|---|
| Documentation | Indicates terms of agreement 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 < Type (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Type |
|---|---|
| Documentation | 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 < VolumeMeasure (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VolumeMeasure |
|---|---|
| Documentation | Volume Measurements More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Cubic Inches | Cubic inches |
| Cubic Feet | Cubic feet |
| Cubic Centimeters | Cubic centimeters |
| Cubic Meters | Cubic meters |
| Other | Other |
| Super-types: | xsd:string < WeightMeasure (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WeightMeasure |
|---|---|
| Documentation | Weight Measurements More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Pounds | Pounds |
| Kilos | Kilos |
| Other | Other |
|
Identification Record |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Creator Name Code |
DCS software creator code |
100242 |
Application Area Sender/CreatorNameCode |
|
2 |
Creator Software Code |
DCS software code name |
100244 |
Application Area Sender/Component |
|
3 |
Interface Version |
Software release version |
100220 |
Application Area Sender/SystemVersion |
|
4 |
Transaction Create Date |
Date the transaction was created |
100430 |
Application Area - CreationDateTime |
|
5 |
Transaction Create Time |
Time the transaction was created |
100440 |
Application Area - CreationDateTime |
|
6 |
Dealer Number |
Dealer code number |
100210 |
Application Area - Sender or Destination/DealerNumber |
|
7 |
Store Number |
Dealer code store number (DMS assigned) |
100240 |
Application Area - Sender or Destination/StoreNumber |
|
8 |
Area Number |
Dealer code area number (DMS vendor assigned) |
100200 |
Application Area - Sender or Destination/AreaNumber |
|
9 |
Destination Name Code |
Code for destination of file - Short Manufacturer or Short DSP code |
106190 |
Application Area Destination/DestinationNameCode |
|
10 |
Destination Software |
For which software destination file is intended(May not be known) |
106200 |
Application Area Destination/DestinationSoftware |
|
11 |
Transaction Type Code |
Transaction type code indicates action to be taken for all records in this transaction set (Will not be in the BODs. Will be handled by OAGI verb) |
106210 |
Not Needed in BOD - Transaction type is specified by OAGI XML verb |
|
12 |
Dealer Country |
Dealer country location |
108430 |
Application Area Sender/DealerContry |
|
13 |
Reference ID |
Enables the sending application to indicate the instance identifier of the event or task that caused the transaction to be created.This is used to correlate a response transaction to an origination transaction |
112260 |
Application Area Sender/ReferenceId |
|
14 |
SenderPartyId |
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. |
112261 |
Application Area Sender/PartyId |
|
15 |
SenderLocationId |
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. |
11262 |
Application Area Sender/LocationId |
|
16 |
SenderServiceId |
The Service Id field identifies the particular service to which a message is being sent from, e.g., an inventory service. |
11263 |
Application Area Sender/ServiceId |
|
17 |
DestinationPartyId |
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. |
11264 |
Application Area Destination/PartyId |
|
18 |
DestinationLocationId |
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. |
11265 |
Application Area Destination/LocationId |
|
19 |
DestinationServiceId |
The Service Id field identifies the particular service to which a message is being sent to, e.g., an inventory service. |
11266 |
Application Area Destination/ServiceId |
|
Invoice Summary |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Invoice Number |
Number for Invoice assigned by manufacturer |
100740 |
Header/DocumentId |
|
2 |
Invoice Date |
Date invoice was created |
100730 |
Header/ShipDate |
|
3 |
Transaction Type |
Invoice or Shipment type |
100920 |
Header/TransactionType |
|
4 |
Assigned PDC |
Dealer's regular Parts Distribution Center (PDC) |
100660 |
Header/PDC |
|
5 |
Shipping PDC |
Parts Distribution Center (PDC) for this shipment |
101050 |
Header/ShippingPDC |
|
6 |
Pay Terms |
When payment is due and/or discounts allowed |
100990 |
N/A |
|
7 |
Ship Date |
Parts shipping date |
100732 |
Header/ShipDate |
|
8 |
Ship Carrier |
Carrier used for delivery of part order |
101040 |
Header/ ShimpemtCarrier |
|
9 |
Reference Number |
Dealer-assigned order number for this Invoice/Shipper |
101000 |
Header/ReferenceNumber |
|
10 |
Stock Order Net |
Net amount of stock order |
100736 |
N/A |
|
11 |
Stock Adjustment Value |
Dealer's Stock Adjustment Credit earned on this invoice |
101060 |
N/A |
|
12 |
Total Parts Amount |
Invoice total for parts only |
101130 |
N/A |
|
13 |
Total Accessories Amount |
Invoice total for accessories only |
101100 |
N/A |
|
14 |
Total Other Amount |
Invoice total for miscellaneous only |
101120 |
N/A |
|
15 |
Subtotal Before Discounts |
Interim total prior to adjustments |
101080 |
N/A |
|
16 |
Parts Discount Amount |
Discount Amount for parts only |
100980 |
N/A |
|
17 |
Accessories Discount Amount |
Discount Amount for accessories only |
100650 |
Header/AccessoriesDiscountAmount |
|
18 |
Other Discount Amount |
Discount Amount for miscellaneous only |
100950 |
Header/OtherDiscountAmount |
|
19 |
Total Discount Amount |
Total discounts |
101110 |
Header/TotalDiscountAmount |
|
20 |
Subtotal Including Discount |
Interim total less discounts |
101090 |
N/A |
|
21 |
Extended Amount |
Parts value at dealer unit cost times quantity |
100738 |
N/A |
|
25 |
Allowances Lost Discounts |
Allowed amount for lost discounts |
100728 |
N/A |
|
28 |
Total Miscellaneous Expense |
Total Miscellaneous invoice expenses |
100746 |
N/A |
|
29 |
Excise Tax |
Total Excise tax for invoice |
100700 |
Header Tax/TaxAmount |
|
30 |
Invoice Sales Tax |
Total Sales tax for invoice |
100800 |
Header Tax/TaxAmount |
|
31 |
Handling Restock Charge |
Total invoice additional costs for handling and restocking of returned items |
100710 |
N/A |
|
32 |
Service Freight Charge |
Total service / freight charges for invoice |
100734 |
N/A |
|
33 |
Delivery Charge |
Total additional costs for delivery |
100680 |
N/A |
|
34 |
Invoice Total |
Grand total for invoice |
100910 |
Header/InvoiceTotal |
|
35 |
Order Process Date |
Pick and pack date of order/shipment |
106980 |
Header/ProcessDate |
|
36 |
Sales Promotion Code |
Sales promotion code on invoice/shipment, if any |
107630 |
Header/SalesPromotionCode |
|
37 |
Process Code |
Code designation how the order was shipped (i.e., Overnight) |
107640 |
Header/ProcessCode |
|
Sold To |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Sold To Business Name |
Name of business entity invoiced parts order(s). |
100880 |
N/A |
|
2 |
Sold To Address |
Address of business entity invoiced parts order(s). |
100860 |
N/A |
|
3 |
Sold To City |
City of business entity parts were sold to. |
100870 |
N/A |
|
4 |
Sold To State |
State or province of business entity parts were sold to. |
100890 |
N/A |
|
5 |
Sold To Zip |
Zip or Postal Code of business entity parts were sold to. |
100900 |
N/A |
|
6 |
Sold To Dealer Code |
Dealer code of business entity invoiced for part order(s). |
100748 |
N/A |
|
7 |
Sold To DBA Name |
DBA names of business entity invoiced for parts order(s). |
107680 |
N/A |
|
Ship To |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Ship To Business Name |
Name of business entity parts were shipped to |
100830 |
ShipTo/Name |
|
2 |
Ship To Address |
Address of business entity parts were shipped to |
100810 |
ShipTo- OrganizationAddress/Address |
|
3 |
Ship To City |
City of business entity parts were shipped to |
100820 |
ShipTo- OrganizationAddress/City |
|
4 |
Ship To State |
State or province of business entity parts were shipped to |
100840 |
ShipTo- OrganizationAddress/StateOrProvince |
|
5 |
Ship To Zip |
Zip or Postal Code of business entity parts were shipped to |
100850 |
ShipTo- OrganizationAddress/PostalCode |
|
6 |
Ship To Dealer Code |
Dealer code of business entity parts were shipped to |
107690 |
ShipTo / PartyId |
|
7 |
Ship To DBA Name |
DBA names of business entity parts were shipped to |
107700 |
ShipTo / DBAName |
|
Line Item |
||||
|
Position |
Data Element Name |
Data Element Definition |
DE # |
Mapping to BOD |
|
1 |
Line Item Number |
Item designation other than part number(i.e., line item number of the order/shipment) |
100940 |
Line/LineNumber |
|
2 |
Part Number |
Part number identifier - Part number, unless part type designates a manufacturer code |
104780 |
Line- Item/ItemId |
|
3 |
Part Type |
Specifies whether the parts are indicated by manufacturer part code or Part Number |
105100 |
Line- Item/PartType |
|
4 |
Part Description |
Part number detail description |
104770 |
Line- Item/ItemDescription |
|
5 |
Part Quantity |
Quantity of part ordered |
100780 |
Line/OrderQuantity |
|
6 |
Back Order Quantity |
Quantity of part on back order |
100752 |
Line/BackOrderQuantity |
|
7 |
Line Item Unit Price |
Dealer unit cost of part |
100930 |
Line Price/UnitPrice |
|
8 |
Order Reference Number |
Original order number for line item |
100790 |
Line/OrderReferenceNumber |
|
9 |
Line Item Extended Price |
Parts value at dealer unit cost times quantity |
100970 |
Line Price/TotalCost |
|
10 |
Discount Percentage |
Percentage of discount |
100690 |
Line/DiscountPercentage |
|
11 |
Stock Return Allowance Code |
Code for stock return allowance |
101070 |
N/A |
|
12 |
Part Sales Tax Flag |
Indicates whether or not sales tax applies |
101030 |
Line/TaxInd |
|
13 |
Return Reason Code |
Designates the reason the line item part was returned(i.e., Shortage, error, quality problem, cores return, obsolete, etc.) |
101020 |
Line/ReturnReasonCode |
|
14 |
Restock Code |
Code for restocking item (i.e.; manufacturer product division) |
101010 |
Line/RestockCode |
|
15 |
Class Code |
Identifies class of part (i.e., accessories, replacement, etc.) |
100670 |
Line Item/ClassCode |
|
16 |
Part Class |
Gifts, literature, keys, regular parts -Inventory Class code (if any) used by manufacturer |
100960 |
Line - Item/PartClass |
|
18 |
Unit Pack Size |
Package quantity of part (number of units in each selling package) |
101140 |
Line/UnitPack |
|
19 |
Former Part Number |
Former Part Number for Substitution or Replacement |
106680 |
Line/FormerPartNumber |
|
20 |
Order Line Item Process Date |
Pick and pack date of individual line item in order/shipment |
107650 |
Line/ProcessDate |
|
21 |
Sales Promotion Code for Line Item |
Sales promotion code on invoice/shipment for line item if different from header promotion code |
107660 |
Line/SalesPromotionCode |
|
22 |
Process Code for Line Item |
Code designation how the line item on the order was shipped if different from header process code |
107670 |
Line/ProcessCode |
|
23 |
Part Sales Tax Rate |
Total tax rate that would be charged for part(i.e., City + State +) |
107780 |
Line Tax/TaxRate |
|
24 |
Inventory Movement/Demand Code |
Code designating the inventory rate at which item turns.Indicates national demand.Usually A, B, C, etc. |
107790 |
Line/InventoryMovementDemandCode |
|
25 |
Part Quantity Shipped |
Quantity of part shipped |
109270 |
Line/QuantityShipped |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: