UPS
/
Motor Carrier Package Status (5010)
  • Specification
  • EDI Inspector
Stedi maintains this guide based on public documentation from UPS. Contact UPS for official EDI specifications. To report any errors in this guide, please contact us.
Go to Stedi Network
UPS logo

X12 240 Motor Carrier Package Status (5010)

X12 Release 5010

This X12 Transaction Set contains the format and establishes the data contents of the Motor Carrier Package Status Transaction Set (240) for use within the context of an Electronic Data Interchange (EDI) environment. This standard can be used to provide the status of a package, packages, or group of packages considered a shipment by a motor carrier.

Delimiters
  • ~ Segment
  • * Element
  • > Component
  • ^ Repetition
EDI sample
  • sample 1
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/ups/motor-carrier-package-status-5010/01HNE9Z48PAP5DCF7P6Q06MCGQ
Powered by
Build EDI implementation guides at stedi.com
Overview
ISA
-
Interchange Control Header
Max use 1
Required
GS
-
Functional Group Header
Max use 1
Required
heading
ST
0100
Transaction Set Header
Max use 1
Required
BGN
0200
Beginning Segment
Max use 1
Required
1000 Loop Alternate Delivery Address Receiver
detail
2000 Loop
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1

To start and identify an interchange of zero or more functional groups and interchange-related control segments

Example
ISA-01
I01
Authorization Information Qualifier
Required
Identifier (ID)

Code identifying the type of information in the Authorization Information

00
No Authorization Information Present (No Meaningful Information in I02)
ISA-02
I02
Authorization Information
Required
String (AN)
Min 10Max 10

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)

ISA-03
I03
Security Information Qualifier
Required
Identifier (ID)

Code identifying the type of information in the Security Information

00
No Security Information Present (No Meaningful Information in I04)
ISA-04
I04
Security Information
Required
String (AN)
Min 10Max 10

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)

ISA-05
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2

Code indicating the system/method of code structure used to designate the sender or receiver ID element being qualified

Codes
ISA-06
I06
Interchange Sender ID
Required
String (AN)
Min 15Max 15

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

ISA-07
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2

Code indicating the system/method of code structure used to designate the sender or receiver ID element being qualified

Codes
ISA-08
I07
Interchange Receiver ID
Required
String (AN)
Min 15Max 15

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

ISA-09
I08
Interchange Date
Required
Date (DT)
YYMMDD format

Date of the interchange

ISA-10
I09
Interchange Time
Required
Time (TM)
HHMM format

Time of the interchange

ISA-11
I65
Repetition Separator
Required
String (AN)
Min 1Max 1

Type is not applicable; the repetition separator is a delimiter and not a data element; this field provides the delimiter used to separate repeated occurrences of a simple data element or a composite data structure; this value must be different than the data element separator, component element separator, and the segment terminator

^
Repetition Separator
ISA-12
I11
Interchange Control Version Number
Required
Identifier (ID)

Code specifying the version number of the interchange control segments

00501
Standards Approved for Publication by ASC X12 Procedures Review Board through October 2003
ISA-13
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9

A control number assigned by the interchange sender

ISA-14
I13
Acknowledgment Requested
Required
Identifier (ID)
Min 1Max 1

Code indicating sender's request for an interchange acknowledgment

0
No Interchange Acknowledgment Requested
1
Interchange Acknowledgment Requested (TA1)
ISA-15
I14
Interchange Usage Indicator
Required
Identifier (ID)
Min 1Max 1

Code indicating whether data enclosed by this interchange envelope is test, production or information

I
Information
P
Production Data
T
Test Data
ISA-16
I15
Component Element Separator
Required
String (AN)
Min 1Max 1

Type is not applicable; 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

>
Component Element Separator

Functional Group Header

RequiredMax use 1

To indicate the beginning of a functional group and to provide control information

Example
GS-01
479
Functional Identifier Code
Required
Identifier (ID)

Code identifying a group of application related transaction sets

MZ
Motor Carrier Package Status (240)
GS-02
142
Application Sender's Code
Required
String (AN)
Min 2Max 15

Code identifying party sending transmission; codes agreed to by trading partners

GS-03
124
Application Receiver's Code
Required
String (AN)
Min 2Max 15

Code identifying party receiving transmission; codes agreed to by trading partners

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

Required
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

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)

GS-06
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9

Assigned number originated and maintained by the sender

GS-07
455
Responsible Agency Code
Required
Identifier (ID)
Min 1Max 2

Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480

T
Transportation Data Coordinating Committee (TDCC)
X
Accredited Standards Committee X12
GS-08
480
Version / Release / Industry Identifier Code
Required
String (AN)

Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed

005010
Standards Approved for Publication by ASC X12 Procedures Review Board through October 2003

Heading

ST
0100
Heading > ST

Transaction Set Header

RequiredMax use 1

To indicate the start of a transaction set and to assign a control number

Example
ST-01
143
Transaction Set Identifier Code
Required
Identifier (ID)

Code uniquely identifying a Transaction Set

  • The transaction set identifier (ST01) is used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
240
Motor Carrier Package Status
ST-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9

Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

BGN
0200
Heading > BGN

Beginning Segment

RequiredMax use 1

To indicate the beginning of a transaction set

Example
BGN-01
353
Transaction Set Purpose Code
Required
Identifier (ID)

Code identifying purpose of transaction set

00
Original
BGN-02
127
Reference Identification
Required
String (AN)
Min 1Max 50

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier

  • BGN02 is the transaction set reference number.
Usage notes

WVD Quantum View Data

Required
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

  • BGN03 is the transaction set date.
1000 Loop Alternate Delivery Address Receiver
OptionalMax 1
Variants (all may be used)
1000 Loop Alternate Delivery Address Signer1000 Loop Alternate Delivery Address Ultimate Consignee1000 Loop Bill-to-Party1000 Loop Shipper
N1
0300
Heading > 1000 Loop Alternate Delivery Address Receiver > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (1000) identifies the receiver(s) of the data.
Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

Usage notes

40 = Ship To Email Address

40
Receiver
N1-03
66
Identification Code Qualifier
Required
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

40
Electronic Mail User Code
N1-04
67
Identification Code
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

Ship To Email Address

N3
0500
Heading > 1000 Loop Alternate Delivery Address Receiver > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 2

N4
0600
Heading > 1000 Loop Alternate Delivery Address Receiver > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Usage notes

Shipper City

N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
Usage notes

Shipper State or Province (if available)

N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

Usage notes

Shipper Postal Code

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

Usage notes

Shipper Country Code

1000 Loop Alternate Delivery Address Receiver end
N1
0300
Heading > 1000 Loop Alternate Delivery Address Signer > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (1000) identifies the receiver(s) of the data.
Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

Usage notes

UZ = UPS Access Point

UZ
Signer
N1-03
66
Identification Code Qualifier
Required
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

Usage notes

Access Point Location Identification Qualifier Code

95
Assigned By Transporter
N1-04
67
Identification Code
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

UPS Access Point Location ID

N3
0500
Heading > 1000 Loop Alternate Delivery Address Signer > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 2

N4
0600
Heading > 1000 Loop Alternate Delivery Address Signer > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Usage notes

Shipper City

N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
Usage notes

Shipper State or Province (if available)

N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

Usage notes

Shipper Postal Code

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

Usage notes

Shipper Country Code

1000 Loop Alternate Delivery Address Signer end
1000 Loop Alternate Delivery Address Ultimate Consignee
OptionalMax 1
N1
0300
Heading > 1000 Loop Alternate Delivery Address Ultimate Consignee > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (1000) identifies the receiver(s) of the data.
Example
At least one of Name (N1-02) or Identification Code Qualifier (N1-03) is required
If either Identification Code Qualifier (N1-03) or Identification Code (N1-04) is present, then the other is required
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

Usage notes

UC = Alternate Delivery Address

UC
Ultimate Consignee
Optional
String (AN)
Min 1Max 60

Free-form name

Usage notes

Alternate Delivery Address Name

N1-03
66
Identification Code Qualifier
Optional
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

12
Telephone Number (Phone)
N1-04
67
Identification Code
Optional
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

Alternate Delivery Address Phone Number

N2
0400
Heading > 1000 Loop Alternate Delivery Address Ultimate Consignee > N2

Additional Name Information

OptionalMax use 2

To specify additional names

Example
Required
String (AN)
Min 1Max 60

Alternate Delivery Address Attention Name

N3
0500
Heading > 1000 Loop Alternate Delivery Address Ultimate Consignee > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Alternate Delivery Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Alternate Delivery Address Line 2

N4
0600
Heading > 1000 Loop Alternate Delivery Address Ultimate Consignee > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Usage notes

Alternate Delivery Address City

N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
Usage notes

Alternate Delivery Address State or Province (if available)

N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

Usage notes

Alternate Delivery Address Postal Code

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

Usage notes

Alternate Delivery Address Country Code

1000 Loop Alternate Delivery Address Ultimate Consignee end
N1
0300
Heading > 1000 Loop Bill-to-Party > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (1000) identifies the receiver(s) of the data.
Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

BT
Bill-to-Party
N1-03
66
Identification Code Qualifier
Required
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

25
Carrier's Customer Code
N1-04
67
Identification Code
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

Bill To Account Number or NA

N3
0500
Heading > 1000 Loop Bill-to-Party > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 2

N4
0600
Heading > 1000 Loop Bill-to-Party > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Usage notes

Shipper City

N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
Usage notes

Shipper State or Province (if available)

N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

Usage notes

Shipper Postal Code

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

Usage notes

Shipper Country Code

1000 Loop Bill-to-Party end
N1
0300
Heading > 1000 Loop Shipper > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (1000) identifies the receiver(s) of the data.
Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

SH
Shipper
Optional
String (AN)
Min 1Max 60

Free-form name

Usage notes

Shipper Name if available, otherwise N102 contains the UPS custom code NA to denote that a Shipper Name is not available.

N1-03
66
Identification Code Qualifier
Required
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

25
Carrier's Customer Code
N1-04
67
Identification Code
Required
String (AN)
Min 2Max 80

Code identifying a party or other code

  • This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
Usage notes

Shipper Account Number

N3
0500
Heading > 1000 Loop Shipper > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Shipper Address Line 2

N4
0600
Heading > 1000 Loop Shipper > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
Usage notes

Shipper City

N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
Usage notes

Shipper State or Province (if available)

N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

Usage notes

Shipper Postal Code

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

Usage notes

Shipper Country Code

1000 Loop Shipper end
Heading end

Detail

2000 Loop
RequiredMax >1
LX
0100
Detail > 2000 Loop > LX

Transaction Set Line Number

RequiredMax use 1

To reference a line number in a transaction set

Example
LX-01
554
Assigned Number
Required
Numeric (N0)
Min 1Max 6

Number assigned for differentiation within a transaction set

2500 Loop
OptionalMax >1
N1
0200
Detail > 2000 Loop > 2500 Loop > N1

Party Identification

RequiredMax use 1

To identify a party by type of organization, name, and code

  • This loop (2500) provides the delivery address.
Example
N1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

Usage notes

DA=Actual Delivery Address
ST=Initial Ship-To
UP=Update Ship-To
ZZ is used as a placeholder

DA
Delivery Address
ST
Ship To
UP
Unloading Party
ZZ
Mutually Defined
Required
String (AN)
Min 1Max 60

Free-form name

Usage notes

• If N101 is DA, then N102 is the Actual Delivery Name and may populate if MANO2 is D2.

• If N101 is ST, then N102 is the Ship-To Name and may populate if MAN02 is Ml or M2.

• If N101 is UP, then N102 is the Updated Ship-To Name and may populate if MAN02 is El.

• If Name is not available "NA" will appear as a placeholder.

N2
0300
Detail > 2000 Loop > 2500 Loop > N2

Additional Name Information

OptionalMax use 1

To specify additional names

Example
Required
String (AN)
Min 1Max 60

Free-form name

Usage notes

If N101 is ST, then N201 is Ship-To Attention Name

N3
0400
Detail > 2000 Loop > 2500 Loop > N3

Party Location

OptionalMax use 1

To specify the location of the named party

Example
N3-01
166
Address Information
Required
String (AN)
Min 1Max 55

Address information

Usage notes

Address Line 1

N3-02
166
Address Information
Optional
String (AN)
Min 1Max 55

Address information

Usage notes

Address Line 2

N4
0500
Detail > 2000 Loop > 2500 Loop > N4

Geographic Location

OptionalMax use 1

To specify the geographic place of the named party

Example
N4-01
19
City Name
Optional
String (AN)
Min 2Max 30

Free-form text for city name

  • A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
N4-02
156
State or Province Code
Optional
Identifier (ID)
Min 2Max 2

Code (Standard State/Province) as defined by appropriate government agency

  • N402 is required only if city name (N401) is in the U.S. or Canada.
N4-03
116
Postal Code
Optional
Identifier (ID)
Min 3Max 15

Code defining international postal zone code excluding punctuation and blanks (zip code for United States)

N4-04
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

NM1
0600
Detail > 2000 Loop > 2500 Loop > NM1

Individual or Organizational Name

OptionalMax use 1

To supply the full name of an individual or organizational entity

Example
If either Identification Code Qualifier (NM1-08) or Identification Code (NM1-09) is present, then the other is required
NM1-01
98
Entity Identifier Code
Required
Identifier (ID)

Code identifying an organizational entity, a physical location, property or an individual

Usage notes

UPS assigns no meaning to AD; it is merely a placeholder.

AD
Party to be advised (Written orders)
NM1-02
1065
Entity Type Qualifier
Required
Identifier (ID)

Code qualifying the type of entity

  • NM102 qualifies NM103.
Usage notes

UPS assigns no meaning to 6; it is merely a placeholder.

6
Organization
NM1-08
66
Identification Code Qualifier
Optional
Identifier (ID)

Code designating the system/method of code structure used for Identification Code (67)

Usage notes

Ship To Telephone Number

12
Telephone Number (Phone)
NM1-09
67
Identification Code
Optional
String (AN)
Min 2Max 80

Code identifying a party or other code

Usage notes

Ship to Telephone Number

NTE
0700
Detail > 2000 Loop > 2500 Loop > NTE

Note/Special Instruction

OptionalMax use 1

To transmit information in a free-form format, if necessary, for comment or special instruction

  • The NTE is used to provide specific delivery information when a signature is not available.
Example
NTE-01
363
Note Reference Code
Optional
Identifier (ID)

Code identifying the functional area or purpose for which the note applies

Usage notes

Special Instructions

SPH
Special Handling
NTE-02
352
Description
Required
String (AN)
Min 1Max 80

A free-form description to clarify the related data elements and their content

Usage notes

Special Instructions

2500 Loop end
2700 Loop
RequiredMax >1
L11
1000
Detail > 2000 Loop > 2700 Loop > L11

Business Instructions and Reference Number

RequiredMax use 1

To specify instructions in this business relationship or a reference number

  • This loop (2700) describes the package status.
Example
If either Reference Identification (L11-01) or Reference Identification Qualifier (L11-02) is present, then the other is required
At least one of Reference Identification (L11-01) or Description (L11-03) is required
L11-01
127
Reference Identification
Optional
String (AN)
Min 1Max 50

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier

L11-02
128
Reference Identification Qualifier
Optional
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

L11-03
352
Description
Optional
String (AN)
Min 1Max 80

A free-form description to clarify the related data elements and their content

LS
1070
Detail > 2000 Loop > 2700 Loop > LS

Loop Header

OptionalMax use 1

To indicate that the next segment begins a loop

Example
LS-01
447
Loop Identifier Code
Required
String (AN)
Min 1Max 6

The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE

2710 Loop
OptionalMax >1
MAN
1100
Detail > 2000 Loop > 2700 Loop > 2710 Loop > MAN

Marks and Numbers Information

RequiredMax use 1

To indicate identifying marks and numbers for shipping containers

Example
If either Marks and Numbers Qualifier (MAN-04) or Marks and Numbers (MAN-05) is present, then the other is required
If Marks and Numbers (MAN-06) is present, then Marks and Numbers (MAN-05) is required
MAN-01
88
Marks and Numbers Qualifier
Required
Identifier (ID)

Code specifying the application or source of Marks and Numbers (87)

  • MAN01/MAN02 and MAN04/MAN05 may be used to identify two different marks and numbers assigned to the same physical container.
  • When MAN01 contains code "UC" (U.P.C. Shipping Container Code) and MAN05/MAN06 contain a range of ID numbers, MAN03 is not used. The reason for this is that the U.P.C. Shipping Container code is the same on every carton that is represented in the range in MAN05/MAN06.
CP
Carrier-Assigned Package ID Number
MAN-02
87
Marks and Numbers
Required
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • When both MAN02 and MAN03 are used, MAN02 is the starting number of a sequential range and MAN03 is the ending number of that range.
Usage notes

Scan Activity Codes
Pos.:Field Description
1G*:Agent Scan
DI:Delivery Scan (This scan event will only be sent if COD Service is involved.)
D2:Long Delivery Scan
DS*:Destination Scan
El:Exception Scan
FN*:Failed Notification
IR*:Invoice Removal Successful
MI:Manifest Basic
M2:Manifest Complete
01:Origin Scan
PC*:UPS Courier Confirmation/Vendor Pickup
PS*:Transport Company - USPS Scan
PT*:UPS® Premier Tendered to Express Critical
RE*:Alternate Tracking Number For Returns Exchange
RP*:Delivered - Customer Has Picked Up Package At Retail Location
UD*:Updated Delivery Date
UR*:Undeliverable Returns
VM*:Void Manifest

  • Indicates a "Generic Activity" scan.
>
>

UPS Requirements:
• UPS current maximum length = 2

MAN-03
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • MAN03 and/or MAN06 are only used when sending a range(s) of ID numbers.
  • When both MAN02/MAN03 and MAN05/MAN06 are used to send ranges of ID numbers, the integrity of the two ID numbers must be maintained.
Usage notes

UPS Location

MAN-04
88
Marks and Numbers Qualifier
Optional
Identifier (ID)

Code specifying the application or source of Marks and Numbers (87)

CP
Carrier-Assigned Package ID Number
MAN-05
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

  • When both MAN05 and MAN06 are used, MAN05 is the starting number of a sequential range, and MAN06 is the ending number of that range.
Usage notes

UPS Location State. NA can be used as a placeholder.

MAN-06
87
Marks and Numbers
Optional
String (AN)
Min 1Max 48

Marks and numbers used to identify a shipment or parts of a shipment

Usage notes

UPS Location Country

L11
1150
Detail > 2000 Loop > 2700 Loop > 2710 Loop > L11

Business Instructions and Reference Number

OptionalMax use >1

To specify instructions in this business relationship or a reference number

Example
If either Reference Identification (L11-01) or Reference Identification Qualifier (L11-02) is present, then the other is required
At least one of Reference Identification (L11-01) or Description (L11-03) is required
L11-01
127
Reference Identification
Optional
String (AN)
Min 1Max 50

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier

L11-02
128
Reference Identification Qualifier
Optional
Identifier (ID)
Min 2Max 3

Code qualifying the Reference Identification

L11-03
352
Description
Optional
String (AN)
Min 1Max 80

A free-form description to clarify the related data elements and their content

AT7
1200
Detail > 2000 Loop > 2700 Loop > 2710 Loop > AT7

Shipment Status Details

OptionalMax use >1

To specify 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.

Example
If Shipment Status or Appointment Reason Code (AT7-02) is present, then Shipment Status Indicator (AT7-01) is required
If Time (AT7-06) is present, then Date (AT7-05) is required
If Time Code (AT7-07) is present, then Time (AT7-06) is required
Only one of Shipment Status Indicator (AT7-01) or Shipment Appointment Status Code (AT7-03) may be present
AT7-01
1650
Shipment Status Indicator
Optional
Identifier (ID)
Min 2Max 2

Code indicating the status of a shipment

  • If AT701 is present, AT705 is the date the status occurred. If AT703 is present, AT705 is a date related to an appointment.
  • If AT701 is present, AT706 is the time of the status. If AT703 is present, AT706 is the time of the appointment.
AT7-02
1651
Shipment Status or Appointment Reason Code
Optional
Identifier (ID)
Min 2Max 2

Code indicating the reason a shipment status or appointment reason was transmitted

AT7-03
1652
Shipment Appointment Status Code
Optional
Identifier (ID)
Min 2Max 2

Code indicating the status of an appointment to pickup or deliver a shipment

Optional
Date (DT)
CCYYMMDD format

Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year

Optional
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format

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)

AT7-07
623
Time Code
Optional
Identifier (ID)

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

  • If AT707 is not present then AT706 represents local time of the status.
LT
Local Time
CD3
1300
Detail > 2000 Loop > 2700 Loop > 2710 Loop > CD3

Carton (Package) Detail

OptionalMax use >1

To transmit identifying codes, weights, and other related information related to an individual carton (package)

Example
If either Weight Qualifier (CD3-01) or Weight (CD3-02) is present, then the other is required
If either Rate/Value Qualifier (CD3-07) or Amount Charged (CD3-08) is present, then the other is required
If either Rate/Value Qualifier (CD3-09) or Amount Charged (CD3-10) is present, then the other is required
If Country Code (CD3-14) is present, then Service Level Code (CD3-05) is required
CD3-01
187
Weight Qualifier
Optional
Identifier (ID)
Min 1Max 2

Code defining the type of weight

CD3-02
81
Weight
Optional
Decimal number (R)
Min 1Max 10

Numeric value of weight

Optional
String (AN)
Min 2Max 3

To identify zone

CD3-05
284
Service Level Code
Optional
Identifier (ID)
Min 2Max 2

Code indicating the level of transportation service or the billing service offered by the transportation carrier

CD3-06
108
Pickup or Delivery Code
Optional
Identifier (ID)
Min 1Max 2

Specifies the location or type of pickup or delivery

CD3-07
122
Rate/Value Qualifier
Optional
Identifier (ID)
Min 2Max 2

Code qualifying how to extend charges or interpret value

CD3-08
58
Amount Charged
Optional
Numeric (N2)
Min 1Max 15

For a line item: freight or special charge; for the total invoice: the total charges -- expressed in the standard monetary denomination for the currency specified

  • CD308 is the charge for the single package.
CD3-09
122
Rate/Value Qualifier
Optional
Identifier (ID)
Min 2Max 2

Code qualifying how to extend charges or interpret value

CD3-10
58
Amount Charged
Optional
Numeric (N2)
Min 1Max 15

For a line item: freight or special charge; for the total invoice: the total charges -- expressed in the standard monetary denomination for the currency specified

  • CD310 is the total charge for all of the packages.
CD3-13
591
Payment Method Code
Optional
Identifier (ID)
Min 3Max 3

Code identifying the method for the movement of payment instructions

CD3-14
26
Country Code
Optional
Identifier (ID)
Min 2Max 3

Code identifying the country

  • CD314 is the country where the service is to be performed.
Q7
1400
Detail > 2000 Loop > 2700 Loop > 2710 Loop > Q7

Lading Exception Status

OptionalMax use 1

To specify the status of the shipment in terms of lading exception information

Example
If Packaging Form Code (Q7-02) is present, then Lading Quantity (Q7-03) is required
Q7-01
33
Lading Exception Code
Required
Identifier (ID)

Code indicating the condition of the shipment

Usage notes

UPS assigns no meaning to O; it is merely a placeholder

O
Overage
Q7-02
211
Packaging Form Code
Optional
Identifier (ID)

Code for packaging form of the lading quantity

Usage notes

DBK=Document
ENV=Letter
PKG=Non-document
PLT=Pallet

DBK
Dry Bulk
ENV
Envelope
PKG
Package
PLT
Pallet
Q7-03
80
Lading Quantity
Optional
Numeric (N0)
Min 1Max 7

Number of units (pieces) of the lading commodity

Usage notes

Package count

2710 Loop end
LE
1420
Detail > 2000 Loop > 2700 Loop > LE

Loop Trailer

OptionalMax use 1

To indicate that the loop immediately preceding this segment is complete

Example
LE-01
447
Loop Identifier Code
Required
String (AN)
Min 1Max 6

The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE

2700 Loop end
2000 Loop end
Detail end

Summary

SE
0100
Summary > SE

Transaction Set Trailer

RequiredMax use 1

To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)

Example
SE-01
96
Number of Included Segments
Required
Numeric (N0)
Min 1Max 10

Total number of segments included in a transaction set including ST and SE segments

SE-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9

Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

Summary end

Functional Group Trailer

RequiredMax use 1

To indicate the end of a functional group and to provide control information

Example
GE-01
97
Number of Transaction Sets Included
Required
Numeric (N0)
Min 1Max 6

Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element

GE-02
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9

Assigned number originated and maintained by the sender

Interchange Control Trailer

RequiredMax use 1

To define the end of an interchange of zero or more functional groups and interchange-related control segments

Example
IEA-01
I16
Number of Included Functional Groups
Required
Numeric (N0)
Min 1Max 5

A count of the number of functional groups included in an interchange

IEA-02
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9

A control number assigned by the interchange sender

EDI Samples

sample 1

ST*240*000004837~
BGN*00*QVD*20060109~
N1*SH*PADMA INC*25*123456~
N3*100 MAY FLOWER~
N4*CITY*ST*12345*US~
N1*BT**25*XYZXYZ~
LX*1~
N1*ST*REFRACTORIES., INC.~
N3*235 MUKKAMALLA~
N4*VIZAG*HY*99999*US~
L11*1Z2222222222222222*2I*A4~
LS*2710~
MAN*CP*M2**CP*NA~
L11*FINE*CR*SHPREF1/~
L11*DINE*CR*PKGREF1/~
L11*00*Zz*NA~
AT7*X6*71***20060109*063524*LT~
AT7***AA**20060106~
AT7***AC**20060111~
CD3*A3*2.5***CG~
CD3*************CCE~
Q7*O*PKG*1~
LE*2710~
SE*24*000004837~

Stedi is a registered trademark of Stedi, Inc. All names, logos, and brands of third parties listed on this page are trademarks of their respective owners (including “X12”, which is a trademark of X12 Incorporated). Stedi, Inc. and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.