Uses the Component:ShipmentCarrierDetailType
The ShipmentCarrierDetail component is used to describe the shipment carrier to be used for a shipment and the method by which the shipment will be made.
Table 6.29. Fields and Components
| Name | Description | Occurrence | Type | Data Type | User Notes |
|---|---|---|---|---|---|
| ShipmentCarrierCompanyCode |
Preferred carrier for delivery of a part. | 0..1 | Field | sqdt:ShipmentCarrierCompanyCodeType | |
| ShipmentCarrierServiceLevelCode |
Indicates the priority of service to be provided by the Shipment Carrier. | 0..1 | Field | sqdt:ShipmentCarrierServiceLevelCodeType | |
| ShipmentCarrierTransportMethodTypeCode |
Defines the method by which a shipment carrier transports an item (i.e., air, ground, etc.) | 0..1 | Field | sqdt:ShipmentCarrierTransportMethodTypeCodeType | |
| ShipmentCarrierDeliveryCode | 0..1 | Field | sqdt:ShipmentCarrierDeliveryCodeType | ||
| ShipmentTimePeriod |
The ShipmentTimeFrame component indicates the time or range of time that a shipment will be made or will be available for pick-up | 0..* | Component | PeriodABIEType | |
| PrimaryShipmentCarrierIndicator |
Indicates if a shipment carrier is to be the primary shipment carrier. | 0..1 | Field | udt:IndicatorType | |
| OriginatingWarehouse |
Indicates which warehouse or distribution center from which a shipment originates. | 0..1 | Field | udt:TextType | |
| ShipmentCarrierCollectionMethodCode | 0..1 | Field | sqdt:ShipmentCarrierCollectionMethodCodeType | ||
| ShipmentCarrierRestrictedByWarehouse |
The shipment carrier service has been restricted to use from the specified warehouse. | 0..1 | Field | udt:TextType | |
| ShipmentCarrierUseRestrictedByCountryCode |
Indicates that the use of the shipment carrier company is restricted to a specified country. For example, DHL Canada can only be used for intra Canadian. transfers. | 0..1 | Field | sqdt:CountryCodeType | |
| ShipmentCarrierRestrictedByProgram |
The shipment carrier service has been restricted to use with the specified marketing program. For example, you can only use this shipment carrier in this particular marketing program. | 0..1 | Field | udt:TextType | |
| ShipmentCarrierRestrictedByOrderTypeCode |
Indicates the specified order type by which the service is being restricted. For example, you can use this shipment carrier if you are using stock order type. | 0..1 | Field | sqdt:OrderTypeCodeType | |
| ShipmentCarrierPurposeComment |
Free form text used to further define the shipment carrier service. | 0..1 | Field | udt:TextType | |
| PrimaryShipmentCarrierTransportMethodIndicator |
Indicates if a shipment carrier transport method is to be the primary transport method. | 0..1 | Field | udt:IndicatorType | |
| ShipmentCarrierContact |
The point of contact at the shipment carrier company that supports that shipper. | 0..1 | Component | ContactABIEType | |
| OtherShipmentCarrierCompanyCode |
The purpose of the OtherShipmentCarrierCompanyCode field is to accommodate Shipment Carrier Codes that are unique to an organization and are not captured in the STAR enumerated ShipmentCarrierCompanyCode list. If a code is unique to an organization, the ShipmentCarrierCompanyCode value "Other" is to be used. The OtherShipmentCarrierCode field is to be populated with the unique code not captured by STAR. It is the responsibility of the organization requiring the unique carrier code to maintain an external code list for all values not captured by STAR. The attributes of the OtherShipmentCarrierCompanyCode field are to be used to indicate the entity providing that external list of values as well as the identification for that external list. Sample Use Case: ShipmentCarrierCompanyCode = "Other" ShipmentCarrierDescription = "Allen Logistics" OtherShipmentCarrierCompanyCode = "ANOG" ---listID = "GM-1234" ---listAgencyName = "GM" ---listName = "ShipmentCarriers" | 0..1 | Field | udt:CodeType | |
| ShipmentCarrierCompanyCodeDescription |
Textual description of a shipment carrier. This field should b used in correlation with the OtherShipmentCarrierCompanyCode field. | 0..1 | Field | udt:TextType |
The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.
Example 6.29. ShipmentCarrierDetail
<ShipmentCarrierDetail>
<ShipmentCarrierCompanyCode>......</ShipmentCarrierCompanyCode> [0..1]
<ShipmentCarrierServiceLevelCode>......</ShipmentCarrierServiceLevelCode> [0..1]
<ShipmentCarrierTransportMethodTypeCode>......</ShipmentCarrierTransportMethodTypeCode> [0..1]
<ShipmentCarrierDeliveryCode>......</ShipmentCarrierDeliveryCode> [0..1]
<ShipmentTimePeriod>......</ShipmentTimePeriod> [0..*]
<PrimaryShipmentCarrierIndicator>......</PrimaryShipmentCarrierIndicator> [0..1]
<OriginatingWarehouse>......</OriginatingWarehouse> [0..1]
<ShipmentCarrierCollectionMethodCode>......</ShipmentCarrierCollectionMethodCode> [0..1]
<ShipmentCarrierRestrictedByWarehouse>......</ShipmentCarrierRestrictedByWarehouse> [0..1]
<ShipmentCarrierUseRestrictedByCountryCode>......</ShipmentCarrierUseRestrictedByCountryCode> [0..1]
<ShipmentCarrierRestrictedByProgram>......</ShipmentCarrierRestrictedByProgram> [0..1]
<ShipmentCarrierRestrictedByOrderTypeCode>......</ShipmentCarrierRestrictedByOrderTypeCode> [0..1]
<ShipmentCarrierPurposeComment>......</ShipmentCarrierPurposeComment> [0..1]
<PrimaryShipmentCarrierTransportMethodIndicator>......</PrimaryShipmentCarrierTransportMethodIndicator> [0..1]
<ShipmentCarrierContact>......</ShipmentCarrierContact> [0..1]
<OtherShipmentCarrierCompanyCode>......</OtherShipmentCarrierCompanyCode> [0..1]
<ShipmentCarrierCompanyCodeDescription>......</ShipmentCarrierCompanyCodeDescription> [0..1]
</ShipmentCarrierDetail>