EDI X12 Segment Description
This section describes various segments found in EDI X12 along with descriptins and codes. Note, only the segemengts that explicity say required are needed to send EDI 214 documents to Chaine. All other information is primarily for educational purposes and designed to be a reference.
For Chaine shipment tracking EDI files, only segments relevant to EDI 214 are required.
If you want to learn more about EDI, check out this documentation by IBM
EDI Types:
- 214: Transportation carrier shipment status
- 204: Motor Carrier Load Tender
ISA
Interchange Control Header
To start and identify an interchange of zero or more functional groups and interchange-related control segments.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
ISA01 | Yes | Authorization Information Qualifier: Code to identify the type of information in the Authorization Information. | 2/2 | |
ISA02 | Yes | Authorization Information: Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01). | 10/10 | |
ISA03 | Yes | Authorization Information: Code to identify the type of information in the Security Information. | 2/2 | |
ISA04 | Yes | Security Information: Date expressed as CCYYMMDD: This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03). | 10/10 | |
ISA05 | Yes | Interchange ID Qualifier: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified | 2/2 | |
ISA06 | Yes | Interchange Sender ID: Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element. | 15/15 | |
ISA07 | Yes | Interchange ID Qualifier: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified. | 2/2 | |
ISA08 | Yes | Interchange Receiver ID: Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them. | 15/15 | |
ISA09 | Yes | Interchange Date: Date of the interchange. | 6/6 | |
ISA10 | Yes | Interchange Time: Time of the interchange | 4/4 | |
ISA11 | No | Interchange Control Standards Identifier: Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer | 1/1 | |
ISA12 | No | Interchange Control Version Number: Code specifying the version number of the interchange control segments. | 5/5 | |
ISA13 | No | Interchange Control Number: A control number assigned by the interchange sender | 9/9 | |
ISA14 | No | Acknowledgment Requested: Code sent by the sender to request an interchange acknowledgment (997). | 1/1 | |
ISA15 | Yes | Usage Indicator: Code to indicate whether data enclosed by this interchange envelope is test, production or information. | 1/1 | |
ISA16 | Yes | Component Element Separator: The component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator. | 1/1 |
ISA15 codes:
- T: Test
- Leaave blank for Production
GS
Functional Group Header
Indicates the beginning of a functional group and to provide control information
Send ClientID in GS03. This is required.
The receiver's ID, referred to as a ClientID, is required to be sent in GS03. This will always begin with an AC.
GS*QM*CH*ACWVB8ERN8AY8R*20221222*1940*0001*X*004010
Here, ACWVB8ERN8AY8R is the receiver's ClientID. This will be provided to you upon setup.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
GS01 | Yes | Functional Identifier Code: Code identifying a group of application related transaction sets. | 2/2 | |
GS02 | Yes | Application Sender's Code: : Code identifying party sending transmission; codes agreed to by trading partners. | 2/15 | |
GS03 | Yes | Application Receiver's Code: Code identifying party receiving transmission; codes agreed to by trading partners. | 2/15 | |
GS04 | Yes | Date: Date expressed as CCYYMMDD | 8/8 | |
GS05 | Yes | Time: Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD. | 4/8 | |
GS06 | Yes | Group Control Number: Assigned number originated and maintained by the sender | 1/9 | |
GS07 | Yes | Responsible Agency Code: Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480 | 1/2 | |
GS08 | Yes | Version / Release / Industry Identifier Code: Code indicating the version of the EDI standard being used. | 1/12 |
Comments
A functional group of related transaction sets, within the scope of X12 standards, consists of a collection of similar transaction sets enclosed by a functional group header and a functional group trailer.
ST
Transaction Set Header
This segment indicates the start of a transaction set and to assign a control number - Used in EDI 214
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
ST01 | Yes | Code uniquely Identifying a Transaction Set. Accepted Codes is 214 (= Transportation Carrier Shipment Status Message) | 214 | 3/3 |
ST02 | Yes | Transaction Set Control Number: Identifying control number that must be Unique within the transaction set functional group assigned by the originator for the transaction set. | 100001 | 4/9 |
ST01 has total 298 different codes. Few examples are:
- 214: Transportation Carrier Shipment Status
- 204: Motor Carrier Load Tender
- 315: Status Details (Ocean)
- 810: Invoice
- 820: Payment
- 824: Application Advice
- 850: Purchase Order
- 855: X12 Purchase Order Acknowledgment
Full list can be found at EDI Academy here
Only send EDI 214s for transmitting visibility information to your partner carriers using the Chaine platform. The remaining info is for educational purposes only.
Comments
The transaction set identifier (ST01) used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
B2
Beginning Segment for Shipment Information Transaction
To transmit basic data relating to shipment information.
- Used in EDI 204
B2s are not required
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
B201 | No | Tariff Service Code: Code specifying the types of services for rating purposes | 2/2 | |
B202 | No | Standard Carrier Alpha Code (SCAC) | WFER | 2/4 |
B203 | No | Standard Point Location Code: Code (Standard Point Location) defined by NMFTA point development group as the official code assigned to a city or point (for ratemaking purposes) within a city | 6/9 | |
B204 | No | Shipment Identification Number: Identification number assigned to the shipment by the shipper that uniquely identifies the shipment from origin to ultimate destination and is not subject to modification; (Does not contain blanks or special characters) | 100001 | 1/30 |
B205 | No | Weight Unit Code: Code specifying the weight unit | 1/1 | |
B206 | No | Shipment Method of Payment: Code identifying payment terms for transportation charges | 100001 | 2/2 |
B206 has total 28 codes, here are two examples:
- CC: Collect
- PP: Prepaid (by Seller)
B2A
Set purposes
To allow for positive identification of transaction set purpose
- Used in EDI 204
B2As are not required
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
B2A01 | No | Transaction Set Purpose Code: Code identifying purpose of transaction set | 2/2 | |
B2A02 | No | Application Type: : Code identifying an application. | 2/2 |
#### B2A01 has total 65 codes, here are four examples:
- 00: Origin
- 01: Cancellation
- 04: Change
- 06: Confirmation
B2A02 example:
- LT: Load Tender (LTL)
NTE
Note/Special Instructions
To transmit information in a free-form format, if necessary, for comment or special instruction. Information included here is global and applies to all drop-off locations contained within this transaction set.
The NTE segment permits free-form information/data which, under ANSI X12 standard implementations, is not machine processable. The use of the NTE segment should therefore be avoided, if at all possible, in an automated environment.
- Used in EDI 204
NTEs are not required
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
NTE01 | No | Note Reference Code: Code identifying the functional area or purpose for which the note applies. | 3/3 | |
NTE02 | No | A free-form description to clarify the related data elements and their content | 1/80 |
NTE Example:
- GEN: Entire Transaction Set
- ZZZ: Entire Transaction Set
B10
Beginning Segment for Transportation Carrier Shipment Status Message
To transmit identifying numbers and other basic data relating to the transaction set
Required in EDi 214 transmissions
Send the client or customer's load ID in the B1002 segment.
B10*1388441*L190505-00004*TTLQ
Here:
- L190505-00004 is the Load ID
- 1388441 is your (the sender's) Load ID or identification number
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
B1001 | No | Carrier PRO Number | 205547 | 1/30 |
B1002 | Yes | Client (EDI Receiver) Load Number | T976167 | 1/30 |
B1003 | Yes | Standard Carrier Alpha Code (SCAC) | WFER | 2/4 |
B1004 | No | Inquiry Request Number: Identifying number assigned by inquirer | 1/3 | |
B1005 | No | Reference Identification Qualifier: Code qualifying the Reference Identification | 2/3 | |
B1006 | No | Reference Identification: reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier | 1/30 | |
B1007 | No | Yes/no Condition or Response Code | 1/1 |
Comments:
The NTE segment permits free-form information/data which, under ANSI X12 standard implementations, is not machine processable. The use of the NTE segment should therefore be avoided, if at all possible, in an automated environment.
L11
Business Instructions and Reference Number
To specify instructions in this business relationship or a reference number. Information included here is global and applies to all drop-off locations contained within this transaction set.
L11 with QN qualifiers are required for 214 and 204s.
Use the L11 segment with a QN qualifier to send the stop that is being referenced.
L11*01*QN
The above refers to the first stop.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
L1101 | No | Reference Identification: Reference information as defined for a particular Transaction Set or as specified by the reference identification qualifier | 1/30 | |
L1102 | No | Reference Identification Qualifier: Code qualifying the Reference Identification. | 2/3 | |
L1103 | No | Description: A free-form description to clarify the related data elements and their content | 1/80 |
L1102 Code Examples:
- BM - Bill of Lading Nymber
- CN - Carriers Reference Number (Pro/Invoice)
- PO - Purchase Order Number
- QN - Stop Sequence Number in 213
- Note, this Stop Sequence Number is sent in the S501 element of EDI 204 Load Tender
- 72 - Schedule Reference Number
- BN - Booking Number - sometiems shippers will mark this as a CarrierMove ID (CID), Unique Cosignee ID (UID), or Unique Shipper ID (SID)
Examples
Here is an L11 segment with a TMS Load ID
L11*654321*BN~
Here is an L11 segment with Stop Sequence
L11*1*QN~
Here is an L11 segment with Schedule ID
L11*999999*72~
S5
Stop Off Details
To specify pickup and stop-off detail reference numbers and stop reason.
- Used in EDI 204
Currently S5s are not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
S501 | No | Stop Sequence Number: Identifying number for the specific stop and the sequence in which the stop is to be performed. | 1/3 | |
S502 | No | Stop Reason Code: Code specifying the reason for the stop. | 2/2 | |
S503 | No | Weight: Numeric value of weight | 1/10 | |
S504 | No | Weight Unit Code: Code specifying the weight unit. | 1/1 | |
S505 | No | Number of Units Shipped: Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set. | 1/10 | |
S506 | No | Unit or Basis for Measurement Code: Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken. | 2/2 | |
S507 | No | Volume: Value of volumetric measure. | 1/8 | |
S508 | No | Volume Unit Qualifier: Code identifying the volume unit. | 1/1 |
S502 examples
- CL: Complete Load
- CU: Complete Unload
- PU: Part Unload
- LD: Load
S504 examples
- E: Metric Ton
- K: Kilograms
- L: Pounds
- S: Short Ton
- T: Long Ton
S506 examples
- 09: Tire
- 5B: Batch
- B8: Board
- BB: Base Box
- BD: Bundle
- BR: Barrel
- BX: BOX
- CA: CASE
- CH: Container
- CL: Cylinder
- CH: Container
- CT: Carton
- DR: DRUM
- DZ: DOZEN
- FT: FOOT
- PC: PIECE
- PF: PALLET
- PP: PLATE
- QC: CHANNEL
- SH: SHEET
- SV: SKID
- SY: SQUARE YARD
- TB: TUBE
- TC: TRUCKLOAD
- X2: BUNCH
- Z2: CHEST
- ZZ: Mutually Defined
N1
Name
This segment is used to describe the Name and other information about a specific party. N101 will be a code used to identify which party is being "named" and all following NX segments will refer to this party.
- Used in EDI 204 and 214
Currently N1s are not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
N101 | No | Entity Identifier Code: Code identifying an organizational entity, a physical location, property, or an individual. Accepted codes are BT (Bill-to-party), CN (Cosignee), SH (Shipper), SF (Ship From; also Shipper), ST (Ship to, also Cosignee) | ST | 2/3 |
N102 | No | Name: Free-form name. | 1/60 | |
N103 | No | Identification Code Qualifier: Code designating then system/method of code structure used for Identification Code | 1/2 | |
N104 | No | 4 Identification Code: Code identifying a party or other code | 2/80 | |
N105 | No | Entity Relationship Code: Code describing entity relationship | 2/2 | |
N106 | No | Entity Identifier Code: Code identifying an organizational entity, a physical location, property or individual | 2/3 |
Possible N101 code values:
- BT: Bill-to-party,
- CN: Cosignee,
- SH : Shipper,
- SF: Ship From; also Shipper,
- ST: Ship to, also Cosignee
This list is very extensive and used accross many industries. To view a more comprehensive list of entity identifier codes, check out Ediacademy.
Comments:
This segment, used alone, provides the most efficient method of providing organizational identification.
N3
Address
This segment specifies the address place of the named party in N101. If N101 was SH, this would be the Shipper's (or pick-up) address.
- Used in EDI 204 and 214
Currently N3s are not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
N301 | No | Address Information 1: Address information, usually street address | 1/55 | |
N302 | No | Address Information 2: Suite, Unit, etc.. number |
N4
Geographic Location
This segment specifies the geographic place of the named party in N101. If N101 was SH, this would be the Shipper's (or pick-up) address.
- Used in EDI 204 and 214
Semantic notes:
- N401 through N406 define the Shipper GEO Location when N101 is SF. The fields are separated with a dash.
- N401 through N406 define the Receiver GEO Location when N101 is ST. The fields are separated with a dash.
Currently N4s are not required..
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
N401 | No | City Name: Free-form text for city name | 2/30 | |
N402 | No | State or Province Code: Code (Standard State/Province) as defined by an appropriate government agency. | 2/2 | |
N403 | No | Postal Code: Code defining international postal zone code excluding punctuation and blanks (zip code for the United States). | 3/15 | |
N404 | No | Country Code: Code identifying the country | 2/3 | |
N405 | No | Location Qualifier: Code identifying type of location | 1/2 | |
N406 | No | Location Identifier: Code which identifies a specific location | 1/30 |
Comments:
- N402 is required if city name (N401) is in the U.S. or Canada.
- If N406 is present, then N405 is required.
G62
Date/time
The G62 segment is used as a backup source for capturing the date and time values of a status. The primary location for this data is in the AT7 segment.
Used in EDI 204 and 214
G6202 is the carrier line date.
G6203 is the carrier line time.
Currently N4s are not required..
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
G6201 | No | Date Qualifier Code specifying type of date | 2/2 | |
G6202 | No | Date expressed as CCYYMMDD | 8/8 | |
G6203 | No | Time Qualifier Code specifying the reported time | 1/2 | |
G6204 | No | Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) | 4/8 | |
G6205 | No | Time Code | 1/2 |
G6201 has total 137 codes. 2 examples are:
- 69: Scheduled Pick-Up Date
- 70: Scheduled Delivery Date
G6203 has total 42 codes. 2 examples are:
- U: Scheduled Pick Up Time
- X: Scheduled Delivery Time
AT7
Shipment Status Details
This is the field that specifies the status of a shipment, the reason for that status, the date and time of the status and the date and time of any appointments scheduled. In logistics, when we refer to EDI codes, it will come in this field for EDI 214s.
Required in EDI 214s
Here is where the actual shipment status (AT7), shipment locatoin (MS1) and equipment information (MS2) will be sent:
AT7*X3*NS***20210402*1445*ET
AT7*AF*NS***20210402*1445*ET
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
AT701 | Yes | Shipment Status Code indicating the status of a shipment | 2/2 | |
AT702 | Yes | Shipment Status or Appointment Reason Code indicating the reason a shipment status or appointment reason was transmitted | 2/2 | |
AT703 | No | Shipment Appointment Status Code: Code indicating the status of an appointment to pick-up or deliver a shipment. | 2/2 | |
AT704 | No | Shipment Status or Appointment Reason Code: Code indicating the reason a shipment status or appointment reason was transmitted. | 2/2 | |
AT705 | Yes | Date of status expressed as CCYYMMDD | 8/8 | |
AT706 | Yes | Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00- 59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) | 4/8 | |
AT707 | Yes | Code identifying the time. UT (UTC) is Preferred here. In accordance with International Standards Organization standard 8601, time can be specified by a + or - and an indication in hours in relation to Universal Time Coordinate (UTC) time; since + is a restricted character, + and - are substituted by P and M in the codes that follow Refer to 004010 Data Element Dictionary for acceptable code values. | 2/2 |
Time Codes
- AT: Alaska Time
- CT: Central Time
- ET: Eastern Time
- MT: Mountain
- PT: Pacific Time
- UT: UTC Preferred
- P3: UTC +3
- M3: UTC -3
MS1
Equipment, Shipment, or Real Property Location
This segment is used to specify the location of a piece of equipment, a shipment, or real property in terms of city and state or longitude and latitude. If you're providing a location update, this field is required.
- Used in EDI 214
Required in EDI 214 transmissions.
For MS1s, only latitude (MS105) and longitudes (MS104) are processed.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
MS101 | No | City Name: Free-form text for city name | 2/30 | |
MS102 | No | State or Province Code: Code (Standard State/Province) as defined by appropriate government agency | 2/2 | |
MS103 | No | Country Code: Code identifying the country | 2/3 | |
MS104 | Yes | Longitude Code: Code indicating the longitude in degrees (3 positions), minutes (2 positions), and seconds (2 positions) | 0932024 | 7/7 |
MS105 | Yes | Latitude Code: Code indicating the latitude in degrees (3 positions), minutes (2 positions), and seconds (2 positions) | 0444648 | 7/7 |
MS106 | No | Direction Identifier Code: Code identifying geographic location | 1/1 | |
MS107 | No | Direction Identifier Code: Code identifying geographic location | 1/1 |
A note on Longitude and Latitude formats
Longitude and Latitude formats should be in Degrees°, minutes', seconds"
Correct way to enter longitude and latitudes in EDI documents:
MS2
Equipment or Container Owner and Type
To specify the owner, the identification number assigned by that owner, and the type of equipment. This field is related to location in MS1.
- Used in EDI 214
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
MS201 | Yes | Standard Carrier Alpha Code (SCAC) of equipment/container owner | WFER | 2/4 |
MS202 | Yes | Equipment Number: Sequencing or serial part of an equipment unit’s identifying number (pure numeric form for equipment number is preferred) | A16431 | 1/10 |
MS203 | No | Equipment Description Code: Code identifying type of equipment used for shipment | 2/2 | |
MS204 | No | Equipment Number Check Digit: Number which designates the check digit to a piece of equipment | 1/1 |
MS3
Interline Information
In freight, to interline a shipment is to transfer the shipment between two or more carriers for movement to final destination. This segment is used to describe internline information.
- Used in EDI 204 and 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
MS301 | No | Standard Carrier Alpha Code: Standard Carrier Alpha Code | 2/4 | |
MS302 | No | Routing Sequence Code: Code the relationship of a carrier to a specific shipment movement | 1/2 | |
MS303 | No | City Name: Free-form text for city name | 2/30 | |
MS304 | No | Transportation Method/Type Code: Code specifying the method or type of transportation for the shipment | 1/2 | |
MS305 | No | State or Province Code: Code (Standard State/Province) as defined by appropriate government agency | 2/2 |
LX
Assigned Number
To reference a line number in a transaction set
- Used in EDI 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
LX01 | No | Number assigned for differentiation within a transaction set | 1/6 |
K1
Remarks
To transmit information in a free-form format for comment or special instructions.
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
K101 | No | Free-Form Message: Free-form information | 1/30 | |
K102 | No | Free-Form Message: Free-form information | 1/30 |
Q7
Lading Exception Code
To specify the status of the shipment in terms of lading exception information
- Used in EDI 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
Q701 | No | Lading Exception Code: Code indicating the condition of the shipment. | 1/1 | |
Q702 | No | Packaging Form Code: Code for packaging form of the lading quan | 3/3 | |
Q703 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 |
Lading Exception codes for Q701:
- A: All Short
- D: Damaged
- E: Entire Shipment Refused
- O: Overage
- P: Partial Shipment
- W: Wrong Product
Packaging Form Codes for Q702:
- BAG: Bag
- CTN: Carton
- PCS: Pieces
- PLT: Pallet
AT5
Bill of Lading Handling Requirements
To identify Bill of Lading handling and service requirements. Information included here is global and applies to all drop-off locations contained within this transaction set.
- Used in EDI 204 and 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
AT501 | No | Special Handling Code: Code specifying special transportation handling instructions | 2/3 | |
AT502 | No | Special Services Code: Code identifying the special service | 2/10 | |
AT503 | No | Special Handling Description: Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate | 2/30 |
AT501 examples:
- AGG: Aggregate Tender Discount
- DNF: Do Not Freeze
- FR: Fragile – Handle With Care
- IDL: Inside Delivery
- IPU: Inside Pickup
- NC: Notify Consignee Before Delivery
- TPS: Third Party Service
- LD: Lift Gate
- ZZZ: Mutually Defined
- HM: HAZMAT
AT502 examples:
- CC: Carrier Unload
- CD: COD Request
- DV: Declared Value
- ID: Inside Delivery
- RD: Residential Delivery
- ZZ: Mutually Defined
AT8
Shipment Weight, Packaging and Quantity Data
To specify shipment details in terms of weight, and quantity of handling units
- Used in EDI 204 and 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
AT801 | No | Weight Qualifier: Code defining the type of weight. i.e. G = Gross weight | G | 1/2 |
AT802 | No | Weight Unit Code: Code specifying the weight unit. E = Metric Ton, K = Kilograms, L = Pounds | L | 1/1 |
AT803 | No | Weight: Numeric value of weight | 22000 | 1/10 |
AT804 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 | |
AT805 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 | |
AT806 | No | Volume Unit Qualifier: Code identifying the volume unit | 1/1 | |
AT807 | No | Volume: Value of volumetric measure | 1/8 |
CD3
Carton (Package) Detail
To transmit identifying codes, weights, and other related information related to an individual carton (package)
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
CD301 | No | Weight Qualifier: Code defining the type of weight. i.e. G = Gross weight | G | 1/2 |
CD302 | No | Weight: Numeric value of weight | 1000 | 1/10 |
SPO
Shipment Purchase Order Detail
To specify the purchase order details for a shipment
- Used in 214
This segment is not required.
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
SPO01 | No | Purchase Order Number: Identifying number for Purchase Order assigned by the order/purchaser | 1/22 | |
SPO02 | No | Reference Identification: Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier | 1/30 | |
SPO03 | No | Unit or Basis for Measurement Code: Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken | 2/2 | |
SPO04 | No | Quantity: Numeric value that represents the actual quantity | 1/15 | |
SPO05 | No | Weight Unit Code: Code specifying the weight unit. L = pounds. | L | 1/1 |
SPO06 | No | Weight: Numeric value of weight | 10000 | 1/10 |
SPO07 | No | Application Error Condition Code: Code indicating application error condition | 1/3 |
SE
Transaction Set Trailer
To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
- Used in 204 and 214
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
SE01 | Yes | Number of Included Segments: Total number of segments included in a transaction set including ST and SE segments | 1/10 | |
SE02 | Yes | Transaction Set Control Number: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set | 1000 | 4/9 |
Comments:
SE is the last segment of each transaction set.
GE
Functional Group Trailer
To indicate the end of a functional group and to provide control information.
- Used in 204 and 214
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
GE01 | Yes | Number of Transaction Sets Included: Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element | 1/6 | |
GE02 | Yes | Group Control Number: Assigned number originated and maintained by the send | 1/9 |
Semantics:
The data interchange control number GE02 in this trailer must be identical to the same data element in the associated functional group header, GS06.
Comments:
The use of identical data interchange control numbers in the associated functional group header and trailer is designed to maximize functional group integrity. The control number is the same as that used in the corresponding header.
IEA
Interchange Control Trailer
To define the end of an interchange of zero or more functional groups and interchange-related control segments
- Used in 204 and 214
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
IEA01 | Yes | Number of Included Functional Groups: A count of the number of functional groups included in an interchange | 1/5 | |
IEA02 | Yes | Interchange Control Number: A control number assigned by the interchange sender | 9/9 |
Sample Files:
EDI 214 Example 1
ISA ... ~
GS ... ~
ST*214*00000000~
B10*000000000*1*SCAC~
L11*1*BM~
N1*BT*BILL TO~
N3*BT ADDRESS~
N4*CITY*ST*ZIP~
N1*SH*SHIPPER~
N3*SH ADDRESS~
N4*CITY*ST*ZIP~
N1*CN*CONSIGNEE~
N3*CN ADDRESS~
N4*CITY*ST*ZIP~
MS3~
LX*1~
AT7*X3*NS***20110117*1520*LT~
MS1*CITY*ST*USA~
MS2*SCAC*000000~
L11*1*BM~
MAN~
Q7~
AT5~
AT8*G*L*735*1~
SE*23*00000000~
GE ... ~
IEA ... ~
EDI 214 Example 2
ISA*00* *00* *02*WFER *ZZ*APXG *171222*1940*U*00401*000000014*0*T*n
GS*QM*CH*ACLSN8EUA9KF0S*20221222*1940*0001*X*004010
ST*214*110001
B10*1378272**WFER
L11*BOBS*COM
N1*SF*BOBS DRUMS
LX*1
AT7*X3*NS***20210402*1445*ET
AT7*AF*NS***20210402*1445*ET
MS1*Beach City*OH**0000000*0000000*W*N
MS2*WFER*UNKNOWN
L11*01*QN
AT8*G*L*5000*0
SE*12*110001
ST*214*110002
B10*1378272**WFER
L11*JOES*COM
N1*ST*FABCON
LX*1
AT7*D1*NS***20210403*1600*ET
AT7*X5*NS***20210403*1600*ET
MS1*Savage*MN**0000000*0000000*W*N
MS2*BOBS*UNKNOWN
L11*02*QN
AT8*G*L*5000*0
SE*12*110002
GE*2*11
IEA*1*000000011
Table of all EDI X12 segment codes
Code | Required | Description | Example | Size min/max |
---|---|---|---|---|
ISA01 | Yes | Authorization Information Qualifier: Code to identify the type of information in the Authorization Information. | 2/2 | |
ISA02 | Yes | Authorization Information: Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01). | 10/10 | |
ISA03 | Yes | Authorization Information: Code to identify the type of information in the Security Information. | 2/2 | |
ISA04 | Yes | Security Information: Date expressed as CCYYMMDD: This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03). | 10/10 | |
ISA05 | Yes | Interchange ID Qualifier: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified | 2/2 | |
ISA06 | Yes | Interchange Sender ID: Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element. | 15/15 | |
ISA07 | Yes | Interchange ID Qualifier: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified. | 2/2 | |
ISA08 | Yes | Interchange Receiver ID: Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them. | 15/15 | |
ISA09 | Yes | Interchange Date: Date of the interchange. | 6/6 | |
ISA10 | Yes | Interchange Time: Time of the interchange | 4/4 | |
ISA11 | No | Interchange Control Standards Identifier: Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer | 1/1 | |
ISA12 | No | Interchange Control Version Number: Code specifying the version number of the interchange control segments. | 5/5 | |
ISA13 | No | Interchange Control Number: A control number assigned by the interchange sender | 9/9 | |
ISA14 | No | Acknowledgment Requested: Code sent by the sender to request an interchange acknowledgment (997). | 1/1 | |
ISA15 | Yes | Usage Indicator: Code to indicate whether data enclosed by this interchange envelope is test, production or information. | 1/1 | |
ISA16 | Yes | Component Element Separator: The component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator. | 1/1 | |
GS01 | Yes | Functional Identifier Code: Code identifying a group of application related transaction sets. | 2/2 | |
GS02 | Yes | Application Sender's Code: : Code identifying party sending transmission; codes agreed to by trading partners. | 2/15 | |
GS03 | Yes | Application Receiver's Code: Code identifying party receiving transmission; codes agreed to by trading partners. | 2/15 | |
GS04 | Yes | Date: Date expressed as CCYYMMDD | 8/8 | |
GS05 | Yes | Time: Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD. | 4/8 | |
GS06 | Yes | Group Control Number: Assigned number originated and maintained by the sender | 1/9 | |
GS07 | Yes | Responsible Agency Code: Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480 | 1/2 | |
GS08 | Yes | Version / Release / Industry Identifier Code: Code indicating the version of the EDI standard being used. | 1/12 | |
ST01 | Yes | Code uniquely Identifying a Transaction Set. Accepted Codes is 214 (= Transportation Carrier Shipment Status Message) | 214 | 3/3 |
ST02 | Yes | 2 Transaction Set Control Number: Identifying control number that must be 4/9 M Unique within the transaction set functional group assigned by the originator for the transaction set. | 100001 | 4/9 |
B201 | No | Tariff Service Code: Code specifying the types of services for rating purposes | 2/2 | |
B202 | No | Standard Carrier Alpha Code (SCAC) | WFER | 2/4 |
B203 | No | Standard Point Location Code: Code (Standard Point Location) defined by NMFTA point development group as the official code assigned to a city or point (for ratemaking purposes) within a city | 6/9 | |
B204 | No | Shipment Identification Number: Identification number assigned to the shipment by the shipper that uniquely identifies the shipment from origin to ultimate destination and is not subject to modification; (Does not contain blanks or special characters) | 100001 | 1/30 |
B205 | No | Weight Unit Code: Code specifying the weight unit | 1/1 | |
B206 | No | Shipment Method of Payment: Code identifying payment terms for transportation charges | 100001 | 2/2 |
B2A01 | No | Transaction Set Purpose Code: Code identifying purpose of transaction set | 2/2 | |
B2A02 | No | Application Type: : Code identifying an application. | 2/2 | |
B1001 | No | Carrier PRO Number | 205547 | 1/30 |
B1002 | Yes | Client (EDI Receiver) Load Number | T976167 | 1/30 |
B1003 | Yes | Standard Carrier Alpha Code (SCAC) | WFER | 2/4 |
B1003 | Yes | Standard Carrier Alpha Code (SCAC) | WFER | 2/4 |
B1004 | No | Inquiry Request Number: Identifying number assigned by inquirer | 1/3 | |
B1005 | No | Reference Identification Qualifier: Code qualifying the Reference Identification | 2/3 | |
B1006 | No | Reference Identification: reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier | 1/30 | |
B1007 | No | Yes/no Condition or Response Code | 1/1 | |
L1101 | No | Reference Identification: Reference information as defined for a particular Transaction Set or as specified by the reference identification qualifier | 1/30 | |
L1102 | No | Reference Identification Qualifier: Code qualifying the Reference Identification. Accepted Codes are BM (Bill of Lading Number), CN (Carriers Reference Number; PRO/Invoice) | 2/3 | |
L1103 | No | Description: A free-form description to clarify the related data elements and their content | 1/80 | |
S501 | No | Stop Sequence Number: Identifying number for the specific stop and the sequence in which the stop is to be performed. | 1/3 | |
S502 | No | Stop Reason Code: Code specifying the reason for the stop. | 2/2 | |
S503 | No | Weight: Numeric value of weight | 1/10 | |
S504 | No | Weight Unit Code: Code specifying the weight unit. | 1/1 | |
S505 | No | Number of Units Shipped: Numeric value of units shipped in manufacturer's shipping units for a line item or transaction set. | 1/10 | |
S506 | No | Unit or Basis for Measurement Code: Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken. | 2/2 | |
S507 | No | Volume: Value of volumetric measure. | 1/8 | |
S508 | No | Volume Unit Qualifier: Code identifying the volume unit. | 1/1 | |
N101 | No | Entity Identifier Code: Code identifying an organizational entity, a physical location, property, or an individual. Accepted codes are BT (Bill-to-party), CN (Cosignee), SH (Shipper), SF (Ship From; also Shipper), ST (Ship to, also Cosignee) | ST | 2/3 |
N102 | No | Name: Free-form name. | 1/60 | |
N103 | No | Identification Code Qualifier: Code designating then system/method of code structure used for Identification Code | 1/2 | |
N104 | No | 4 Identification Code: Code identifying a party or other code | 2/80 | |
N105 | No | Entity Relationship Code: Code describing entity relationship | 2/2 | |
N106 | No | Entity Identifier Code: Code identifying an organizational entity, a physical location, property or individual | 2/3 | |
N301 | No | Address Information: Address information | 1/55 | |
N302 | No | Address Information: Address in formation | 1/55 | |
N401 | No | City Name: Free-form text for city name | 2/30 | |
N402 | No | State or Province Code: Code (Standard State/Province) as defined by an appropriate government agency. | 2/2 | |
N403 | No | Postal Code: Code defining international postal zone code excluding punctuation and blanks (zip code for the United States). | 3/15 | |
N404 | No | Country Code: Code identifying the country | 2/3 | |
N405 | No | Location Qualifier: Code identifying type of location | 1/2 | |
N406 | No | Location Identifier: Code which identifies a specific location | 1/30 | |
MS301 | No | Standard Carrier Alpha Code: Standard Carrier Alpha Code | 2/4 | |
MS302 | No | Routing Sequence Code: Code the relationship of a carrier to a specific shipment movement | 1/2 | |
MS303 | No | City Name: Free-form text for city name | 2/30 | |
MS304 | No | Transportation Method/Type Code: Code specifying the method or type of transportation for the shipment | 1/2 | |
MS305 | No | State or Province Code: Code (Standard State/Province) as defined by appropriate government agency | 2/2 | |
G6201 | No | Date Qualifier Code specifying type of date | 2/2 | |
G6202 | No | Date expressed as CCYYMMDD | 8/8 | |
G6203 | No | Time Qualifier Code specifying the reported time | 1/2 | |
G6204 | No | Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) | 4/8 | |
G6205 | No | Time Code | 1/2 | |
AT701 | Yes | Shipment Status Code indicating the status of a shipment | 2/2 | |
AT702 | Yes | Shipment Status or Appointment Reason Code indicating the reason a shipment status or appointment reason was transmitted | 2/2 | |
AT703 | No | Shipment Appointment Status Code: Code indicating the status of an appointment to pick-up or deliver a shipment. | 2/2 | |
AT704 | No | Shipment Status or Appointment Reason Code: Code indicating the reason a shipment status or appointment reason was transmitted. | 2/2 | |
AT705 | Yes | Date of status expressed as CCYYMMDD | 8/8 | |
AT706 | Yes | Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00- 59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) | 4/8 | |
AT707 | Yes | Code identifying the time. In accordance with International Standards Organization standard 8601, time can be specified by a + or - and an indication in hours in relation to Universal Time Coordinate (UTC) time; since + is a restricted character, + and - are substituted by P and M in the codes that follow Refer to 004010 Data Element Dictionary for acceptable code values. | 2/2 | |
MS101 | No | City Name: Free-form text for city name | 2/30 | |
MS102 | No | State or Province Code: Code (Standard State/Province) as defined by appropriate government agency | 2/2 | |
MS103 | No | Country Code: Code identifying the country | 2/3 | |
MS104 | Yes | Longitude Code: Code indicating the longitude in degrees (3 positions), minutes (2 positions), and seconds (2 positions) | 7/7 | |
MS105 | Yes | Latitude Code: Code indicating the latitude in degrees (3 positions), minutes (2 positions), and seconds (2 positions) | 7/7 | |
MS106 | No | Direction Identifier Code: Code identifying geographic location | 1/1 | |
MS107 | No | Direction Identifier Code: Code identifying geographic location | 1/1 | |
MS201 | Yes | Standard Carrier Alpha Code (SCAC) of equipment/container owner | WFER | 2/4 |
MS202 | Yes | Equipment Number: Sequencing or serial part of an equipment unit’s identifying number (pure numeric form for equipment number is preferred) | A16431 | 1/10 |
MS203 | No | Equipment Description Code: Code identifying type of equipment used for shipment | 2/2 | |
MS204 | No | Equipment Number Check Digit: Number which designates the check digit to a piece of equipment | 1/1 | |
MS301 | No | Standard Carrier Alpha Code: Standard Carrier Alpha Code | 2/4 | |
MS302 | No | Routing Sequence Code: Code the relationship of a carrier to a specific shipment movement | 1/2 | |
MS303 | No | City Name: Free-form text for city name | 2/30 | |
MS304 | No | Transportation Method/Type Code: Code specifying the method or type of transportation for the shipment | 1/2 | |
MS305 | No | State or Province Code: Code (Standard State/Province) as defined by appropriate government agency | 2/2 | |
K101 | No | Free-Form Message: Free-form information | 1/30 | |
K102 | No | Free-Form Message: Free-form information | 1/30 | |
Q701 | No | Lading Exception Code: Code indicating the condition of the shipment. | 1/1 | |
Q702 | No | Packaging Form Code: Code for packaging form of the lading quan | 3/3 | |
Q703 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 | |
AT501 | No | Special Handling Code: Code specifying special transportation handling instructions | 2/3 | |
AT502 | No | Special Services Code: Code identifying the special service | 2/10 | |
AT503 | No | Special Handling Description: Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate | 2/30 | |
AT801 | No | Weight Qualifier: Code defining the type of weight. i.e. G = Gross weight | G | 1/2 |
AT802 | No | Weight Unit Code: Code specifying the weight unit. E = Metric Ton, K = Kilograms, L = Pounds | L | 1/1 |
AT803 | No | Weight: Numeric value of weight | 22000 | 1/10 |
AT804 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 | |
AT805 | No | Lading Quantity: Number of units (pieces) of the lading commodity | 1/7 | |
AT806 | No | Volume Unit Qualifier: Code identifying the volume unit | 1/1 | |
AT807 | No | Volume: Value of volumetric measure | 1/8 | |
CD301 | No | Weight Qualifier: Code defining the type of weight. i.e. G = Gross weight | G | 1/2 |
CD302 | No | Weight: Numeric value of weight | 1000 | 1/10 |
SPO01 | No | Purchase Order Number: Identifying number for Purchase Order assigned by the order/purchaser | 1/22 | |
SPO02 | No | Reference Identification: Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier | 1/30 | |
SPO03 | No | Unit or Basis for Measurement Code: Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken | 2/2 | |
SPO04 | No | Quantity: Numeric value that represents the actual quantity | 1/15 | |
SPO05 | No | Weight Unit Code: Code specifying the weight unit. L = pounds. | L | 1/1 |
SPO06 | No | Weight: Numeric value of weight | 10000 | 1/10 |
SPO07 | No | Application Error Condition Code: Code indicating application error condition | 1/3 | |
SE01 | No | Number of Included Segments: Total number of segments included in a transaction set including ST and SE segments | 1/10 | |
SE02 | No | Transaction Set Control Number: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set | 1000 | 4/9 |
GE01 | Yes | Number of Transaction Sets Included: Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element | 1/6 | |
GE02 | Yes | Group Control Number: Assigned number originated and maintained by the send | 1/9 | |
IEA01 | Yes | Number of Included Functional Groups: A count of the number of functional groups included in an interchange | 1/5 | |
IEA02 | Yes | Interchange Control Number: A control number assigned by the interchange sender | 9/9 |
List of EDI 214 AT7 Codes
Here is a general list of EDI codes. These are by no means required, nor is this list comprehensive. It is meant for information purposes.
ediCodes = {
A3: 'Shipment Returned to Shipper',
A9: 'Shipment Damaged',
AF: 'Carrier Departed Pick-up Location with Shipment',
AG: 'Estimated Delivery',
AH: 'Attempted Delivery',
AI: 'Shipment has been Reconsigned',
AJ: 'Tendered for Delivery',
AM: 'Loaded On Truck',
AP: 'Delivery Not Completed',
AR: 'Rail Arrival At Destination Ramp',
B6: 'Estimated to Arrive at Carrier Terminal',
BA: 'Connecting Line or Cartage Pick-up',
BC: 'Storage in Transit',
D1: 'Completed Unloading at Delivery Location',
I1: 'In-Gate',
J1: 'Delivered To Connecting Line',
OA: 'Out-Gate',
K1: 'Arrived at Customs',
OO: 'Paperwork Received - Did not Receive Shipment or Equipment',
P1: 'Departed Terminal Location',
R1: 'Received from Prior Carrier',
RL: 'Rail Departure from Origin Ramp',
S1: `Trailer Spotted at Consignee's Location`,
X1: 'Arrived at Delivery Location',
X2: `Estimated Date and/or Time of Arrival at Consignee's Location`,
X3: 'Arrived at Pick-up Location',
X4: 'Arrived At Terminal Location',
AV: 'Available For Delivery',
A7: 'Refused By Consignee',
SD: 'Shipment Delayed',
X5: 'Arrived At Delivery Location Loading Dock',
X6: 'En Route to Delivery Location '
}
Examples of EDI 214 AT7 status codes
Common for Full truckload and Intermodal/Rail Shipments - Inbound
AA - Scheduled Pick-Up Appoint
X2 – Estimated Date and Time of Arrival at Delivery Location
X3 – Arrived at Pick-Up Location
AF – Departed From Pick-Up Location
RL – Rail Departure from Origin Intermodal Ramp (Required only from Intermodal/Rail Transport carriers)
AR – Rail Arrived at Destination Intermodal Ramp (Required only from Intermodal/Rail Transport carriers)
X1 - Arrived at Delivery Location
D1 – Completed Unloading at Delivery Location-
Common for Less Than Full Truckload Carriers
AF – Departed From Pick-Up Location
AG – Estimated Delivery Date
X4 – Arrived Terminal Location (for every Terminal along the route)
P1 – Departed Terminal Locations (for every Terminal along the route)
S1 – Spotted at Consignee’s Location
Or
D1 – Completed Unloading at Delivery Location
Port to Consolidator moves
P1 – Departed Terminal Locations
X1 - Arrived at Delivery Location
International Freight Movement
AA - Scheduled Pick-Up Appoint
BC – Storage in Transit
X4 – Arrived Terminal Location (for every Terminal along the route)
P1 – Departed Terminal Locations