UPS
/
Inventory Inquiry/Advice
  • 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 846 Inventory Inquiry/Advice

X12 Release 5010

This X12 Transaction Set contains the format and establishes the data contents of the Inventory Inquiry/Advice Transaction Set (846) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used in the following ways: (1) for a seller of goods and services to provide inventory information to a prospective purchaser, with no obligation to the purchaser to acquire these goods or services; (2) for a representative of a seller of goods and services to supply inventory information to that seller; (3) for one location to supply another location with inventory information; and (4) for an inquiry as to the availability of inventory with no obligation on the seller of goods and services to reserve that inventory.

Delimiters
  • ~ Segment
  • * Element
  • > Component
  • ^ Repetition
EDI sample
  • Sample
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/ups/inventory-inquiryadvice/01H28RJWDPEKQZPB5WMATTJDYX
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
BIA
0200
Beginning Segment for Inventory Inquiry/Advice
Max use 1
Required
N1 Loop
detail
LIN 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

IB
Inventory Inquiry/Advice (846)
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).
846
Inventory Inquiry/Advice
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

BIA
0200
Heading > BIA

Beginning Segment for Inventory Inquiry/Advice

RequiredMax use 1

To indicate the beginning of an Inventory Inquiry/Advice Transaction Set

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

Code identifying purpose of transaction set

08
Status
BIA-02
755
Report Type Code
Required
Identifier (ID)

Code indicating the title or contents of a document, report or supporting item

LC
Location Inventory Report
BIA-03
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

  • BIA03 identifies the number of the inquiry/advice that is transferred.
Required
Date (DT)
CCYYMMDD format

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

  • BIA04 identifies the date of the inquiry/advice that is transferred.
Usage notes

Date Transaction File Generated

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)

  • BIA05 identifies the time of the inquiry/advice that is transferred.
Usage notes

Time Transaction File Generated

N1 Loop
OptionalMax >1
N1
0800
Heading > N1 Loop > N1

Party Identification

RequiredMax use 1

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

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

WH
Warehouse
Optional
String (AN)
Min 1Max 60

Free-form name

Usage notes

Client Warehouse Division Code

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

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

54
Warehouse
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

Client Warehouse Code

N1 Loop end
Heading end

Detail

LIN Loop
RequiredMax >1
LIN
0100
Detail > LIN Loop > LIN

Item Identification

RequiredMax use 1

To specify basic item identification data

Example
If either Product/Service ID Qualifier (LIN-04) or Product/Service ID (LIN-05) is present, then the other is required
LIN-01
350
Assigned Identification
Optional
String (AN)
Min 1Max 20

Alphanumeric characters assigned for differentiation within a transaction set

  • LIN01 is the line item identification
Usage notes

Format 00009

LIN-02
235
Product/Service ID Qualifier
Required
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

  • LIN02 through LIN31 provide for fifteen different product/service IDs for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU.
VC
Vendor's (Seller's) Catalog Number
VN
Vendor's (Seller's) Item Number
LIN-03
234
Product/Service ID
Required
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Client Material Number

LIN-04
235
Product/Service ID Qualifier
Optional
Identifier (ID)

Code identifying the type/source of the descriptive number used in Product/Service ID (234)

UP
UCC - 12

Data structure for the 12 digit EAN.UCC (EAN International.Uniform Code Council) Global Trade Identification Number (GTIN). Also known as the Universal Product Code (U.P.C.).

LIN-05
234
Product/Service ID
Optional
String (AN)
Min 1Max 48

Identifying number for a product or service

Usage notes

Item UPC Code

PID
0300
Detail > LIN Loop > PID

Product/Item Description

OptionalMax use 200

To describe a product or process in coded or free-form format

Example
PID-01
349
Item Description Type
Required
Identifier (ID)

Code indicating the format of a description

  • If PID01 equals "F", then PID05 is used. If PID01 equals "S", then PID04 is used. If PID01 equals "X", then both PID04 and PID05 are used.
F
Free-form
PID-05
352
Description
Optional
String (AN)
Min 1Max 80

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

Usage notes

Product Description

DTM
1000
Detail > LIN Loop > DTM

Expiration

OptionalMax use 10

To specify pertinent dates and times

Example
Variants (all may be used)
DTMLot Number Expiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

Code specifying type of date or time, or both date and time

036
Expiration

Date coverage expires.

Optional
Date (DT)
CCYYMMDD format

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

Usage notes

Expiration Date. Either qualifier can be sent, per client request.

DTM
1000
Detail > LIN Loop > DTM

Lot Number Expiration

OptionalMax use 10

To specify pertinent dates and times

Example
Variants (all may be used)
DTMExpiration
DTM-01
374
Date/Time Qualifier
Required
Identifier (ID)

Code specifying type of date or time, or both date and time

208
Lot Number Expiration
Optional
Date (DT)
CCYYMMDD format

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

Usage notes

Expiration Date. Either qualifier can be sent, per client request.

REF
1400
Detail > LIN Loop > REF

Location on Product Code

OptionalMax use >1

To specify identifying information

Example
Variants (all may be used)
REFLot NumberREFShipment Origin Code
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

L2
Location on Product Code
REF-02
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

Usage notes

Product Status

REF
1400
Detail > LIN Loop > REF

Lot Number

OptionalMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

LT
Lot Number
REF-02
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

Usage notes

Lot Number

REF
1400
Detail > LIN Loop > REF

Shipment Origin Code

OptionalMax use >1

To specify identifying information

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

4B
Shipment Origin Code
REF-02
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

Usage notes

Country of Origin

QTY Loop
OptionalMax >1
QTY
3200
Detail > LIN Loop > QTY Loop > QTY

Quantity Information

RequiredMax use 1

To specify quantity information

Example
QTY-01
673
Quantity Qualifier
Required
Identifier (ID)

Code specifying the type of quantity

15
Quantity in Hold Out

Hold Inventory (for REF02 = "ACC")

20
Unusable Quantity

Total Unavailable Inventory

33
Quantity Available for Sale (stock quantity)

Total Available Inventory

35
Inventory on Shelf + Work in Progress

Available Transitional Inventory

37
Work In Process

Carton Inventory

A1
Acceptable Unserviceable Quantity

Indicates what portion of the total requested quantity may be accepted in an unserviceable condition.

Unavailable Transitional inventory

GZ
Active Listings

Available Active Inventory

KM
Active Line Items Delinquent

Unavailable Case inventory

RJ
Quantity Available on Shelf

Available Case Inventory

TO
Total

Total SKU Inventory

Y4
Number of Active Accounts This Cycle

Available Case Pick Inventory

QTY-02
380
Quantity
Optional
Decimal number (R)
Min 1Max 15

Numeric value of quantity

Usage notes

"15" = Hold Inventory (for REF02 = "ACC")
"20" = Total Unavailable Inventory
"33" = Total Available Inventory
"35" = Available Transitional Inventory
"37" = Carton Inventory
"A1" = Unavailable Transitional inventory
"GZ" = Available Active Inventory
"KM" = Unavailable Case inventory
"RJ" = Available Case Inventory
"TO" = Total SKU Inventory
"Y4" = Available Case Pick Inventory

QTY-03
C001
Composite Unit of Measure
OptionalMax use 1
To identify a composite unit of measure (See Figures Appendix for examples of use)
C001-01
355
Unit or Basis for Measurement Code
Required
Identifier (ID)
Min 2Max 2

Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken

LS
3800
Detail > LIN Loop > QTY 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

REF Loop
OptionalMax >1
REF
3900
Detail > LIN Loop > QTY Loop > REF Loop > REF

Reference Information

RequiredMax use 1

To specify identifying information

  • The REF loop conveys serial number, lot number, and inventory data.
Usage notes

ACC - Lock Code (when QTY01 = "15")
SE - Serial Number(s) with the Lock Code above

ACC and SE segments will occur within the same LS loop.

Example
REF-01
128
Reference Identification Qualifier
Required
Identifier (ID)

Code qualifying the Reference Identification

ACC
Status
SE
Serial Number
REF-02
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

Usage notes

When REF01 = "ACC" this is either the UPS Lock Code or Client Lock Code (if requested).

REF Loop end
LE
4400
Detail > LIN Loop > QTY 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

QTY Loop end
LIN Loop end
Detail end

Summary

CTT
0100
Summary > CTT

Transaction Totals

OptionalMax use 1

To transmit a hash total for a specific element in the transaction set

  • Number of line items (CTT01) is the accumulation of number of LIN segments. If used, hash total (CTT02) is the sum of the values of the quantities (QTY02) of each QTY segment.
Example
CTT-01
354
Number of Line Items
Required
Numeric (N0)
Min 1Max 6

Total number of line items in the transaction set

SE
0200
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

BIA*08*LC*333458792*20170323*195019~
N1*WH*001*54*1001~
LIN*00001*VN*081871111~
PID*F****Product 1 Description~
QTY*TO*12*EA~
QTY*RJ*7*EA~
QTY*20*5*EA~
QTY*KM*5*EA~
QTY*33*7*EA~
QTY*15*5*EA~
LS*REF~
REF*ACC*RT~
LE*REF~
LIN*00002*VN*081871122~
PID*F****Product 2 Description~
DTM*036*20170128~
REF*LT*CB22328~
QTY*TO*8*EA~
QTY*20*8*EA~
QTY*KM*8*EA~
QTY*15*6*EA~
LS*REF~
REF*ACC*DM~
LE*REF~
QTY*15*2*EA~
LS*REF~
REF*ACC*EX~
LE*REF~
LIN*00003*VN*081871133~
PID*F****Product 3 Description~
QTY*TO*8*EA~
QTY*GZ*3*EA~
QTY*20*5*EA~
QTY*KM*5*EA~
QTY*33*3*EA~
LS*REF~
REF*SE*410141501~
REF*SE*410141502~
REF*SE*410141503~
LE*REF~
QTY*15*2*EA~
LS*REF~
REF*ACC*DM~
REF*SE*410141505~
REF*SE*410141507~
LE*REF~
QTY*15*3*EA~
LS*REF~
REF*ACC*RT~
REF*SE*410141504~
REF*SE*410141506~
REF*SE*410141508~
LE*REF~
CTT*3~

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.