EDI communication (X12) — field guide

As a Resident’s warehouse, you must have heard the term EDI.Segment is Resident’s EDI platform provider, and we are here to help you with all the information you need for communicating with Resident in EDI standards.

What is EDI or X12?

Electronic Data Interchange (EDI) is the automated, computer-to-computer exchange of standard electronic documents (such as invoices, purchase orders, etc.) between business partners over a secure, standardized connection.X12 is a common standard used in the USA for EDI documents.

How does it work?

Step	What happens	Document
1	Resident will send a Purchase Order to Segment’s EDI platform.	—
2	Segment’s EDI platform will translate the PO into an EDI-format X12 based.	—
3	You (Resident’s Warehouse) will receive the X12-850 via source methods of your choosing (such as SSH, FTP, SFTP, AS2).	`850`
4	When you receive the PO, you will send back the PO confirmation with an X12-977 file to Segment.	`977`
5	Segment will translate the EDI-formatted confirmation and send it to Resident.	—
6	Once the goods are packed and ready to ship, you (Resident’s Warehouse Supplier) will send an X12-856 with Shipping Notice to Segment’s EDI System, which will translate and send it directly to Resident ERP system.	`856`
7	Segment will send you the confirmation for receiving the Shipping Certificate by sending you back an X12-997 file.	`997`

Documents at a glance

Document	Name	Variant	Example file	Specification
850	Purchase Order	B2C	Download	X12 spec
850	Purchase Order	Retail	Download	X12 spec
855	Orders Acknowledgment	—	Download	X12 spec
856	Advance Ship Notice	B2C	Download	X12 spec
856	Advance Ship Notice	Retail	Download	X12 spec
860	Order Cancellation	—	Download	X12 spec
865	Purchase Order Change Acknowledgement	—	Download	X12 spec
846	Inventory Report	—	Download	X12 spec

850–Purchase Order (B2C)

Segment Element Value

GSFunctional Groups Envelope

GS

PR

STTransaction Set Header

ST01

850

ST02 Transaction Set Control Number

BEGBeginning Segment

BEG01

BEG02 DS

BEG03 Shipment ID

BEG04 Empty

BEG05 Purchase Order Date (CCYYMMDD)

REFReference

REF01

WS

REF02 Warehouse Code

REFReference

REF01

CO

REF02 PO Number

REFReferenceOptional

REF01

IT

REF02 WEBSITE

TD5Carrier Details

TD505

Carrier identity:

FedEx Ground	`FDXG`
FedEx Freight	`FDXF`
UPS Ground	`UPSG`
UPS Freight	`UPSF`
updike	`UPDK`

DTMDate Reference

DTM01

010

DTM02 Date for Requested Shipment (CCYYMMDD)

N1Ship From

N101

SF

N102 Warehouse name

N1Ship To

N101

ST

N102 Customer Name

N3Address

N301

Customer Address

N4Geographic Location

N401

City Name

N402 State Code

N403 Postal Code

N404 Country Code

PERContact

PER01

DC

PER02 Customer Name

PER03 TE

PER04 Customer Phone

PO1Baseline Item Data

PO101

Line Item Number

PO102 Quantity Ordered

PO103 A’

PO104 Line Price

PO106 UP

PO107 UPC Code

PO108 SK

PO109 SKU

PIDProduct Item Description

PID01

PID05 Free Form Item Description

CTTTransaction Totals

CTT01

Number of Line Items

SETransactions Set Trailers

SE01

Number of Included Segments

SE02 Transaction Set Control Number

Download Example 850 B2C File More info

850–Purchase Order (Retail)

Segment Element Value

GSFunctional Groups Envelope

GS

PR

STTransaction Set Header

ST01

850

ST02 Transaction Set Control Number

BEGBeginning Segment

BEG01

BEG02 RT – for Retail orders
DS – for Retail D2C orders

BEG03 Origin PO Number

BEG04 Empty

BEG05 Purchase Order Date (CCYYMMDD)

REFReference

REF01

PH

REF02 0

REFReference

REF01

WS

REF02 Warehouse Code

REFReference

REF01

CO

REF02 Resident PO Number

REFReference

REF01

MR

REF02 Store Name

REFReference

REF01

IT

REF02 RETAIL

REFReference

REF01

4H

REF02 Origin PO Number 2

REFReference

REF01

8M

REF02 Customer ID

REFReference

REF01

BN

REF02 9046519037891

DTMDate Reference

DTM01

010

DTM02 Date for Requested Shipment (CCYYMMDD)

DTM01 063

DTM02 Do Not Deliver After

DTM01 064

DTM02 Do Not Deliver Before

TD5Carrier Details

TD505

Carrier identity:

FedEx Ground	`FDXG`
FedEx Freight	`FDXF`
UPS Ground	`UPSG`
UPS Freight	`UPSF`
updike	`UPDK`

N9Customer Comments

N901

SH

N902 Customer Comments

N1Ship From

N101

SF

N102 Warehouse name

N1Ship To

N101

ST

N102 Customer Name

N103 92

N104 Location ID

N3Address

N301

Customer Address

N4Geographic Location

N401

City Name

N402 State Code

N403 Postal Code

N404 Country Code

PERContact

PER01

DC

PER02 Customer Name

PER03 TE

PER04 Customer Phone

PO1Baseline Item Data

PO101

Line Item Number

PO102 Quantity Ordered

PO103 EA

PO104 Line Price

PO106 UP

PO107 UPC Code

PO108 SK

PO109 SKU

PO110 SH

PO111 Shipment ID

PO112 PO

PO113 Resident Order Number

PO114 BN

PO115 SKU NUMBER

PO116 IN

PO117 Buyer’s Item Number

PO118 BN

PO119 Bar-Coded Serial Number

PO120 VX

PO121 Vendor’s Specification Number

PIDProduct Item Description

PID01

PID05 Free Form Item Description

CTTTransaction Totals

CTT01

Number of Line Items

SETransactions Set Trailers

SE01

Number of Included Segments

SE02 Transaction Set Control Number

Download Example 850 Retail File More info

855 – Orders Acknowledgment

Segment	Element	Value
`GS`Functional Groups Envelope	`GS`	`PR`
`ST`Transaction Set Header	`ST01`	`855`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BAK`Beginning Segment for Orders Ack.	`BAK01`	00
	`BAK02`	`AC` – With Changes (and in case of ACK01=`IR` – Rejected) `AD` – With No Changes
	`BAK03`	Order Number
	`BAK04`	Ack Date (CCYYMMDD)
`REF`Shipment Id Identification	`REF01`	`PO`
`REF`Shipment Id Identification	`REF02`	Shipment ID (24 characters)
`PO1`Baseline Item Data	`PO101`	Line Item Number
	`PO102`	Quantity Ordered
	`PO103`	`EA`
	`PO106`	`UP`
	`PO107`	UPC Code
	`PO108`	`SK`
	`PO109`	SKU
`ACK`Baseline Item Ack.	`ACK01`	`IA` Item Accepted `IC` Item Accepted – Changes Made `IR` Item Rejected
	`ACK02`	Quantity To Be Supplied `0` In Case Of ACK01=`IR` PO120 – In Case of ACK01=`IA`
	`ACK03`	`EA`
`REF`Actual Warehouse	`REF01`	`WH`
`REF`Actual Warehouse	`REF02`	The warehouse the item will be send from.
`CTT`Transaction Totals	`CTT01`	Number of Line Items
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments

Download Example 855 File More info

856–Advance Ship Notice (B2C)

Segment	Element	Value
`GS`Functional Groups Envelope	`GS01`	`SH`
	`GS06`	GS Number
	`GS8`	X12 Version
`ST`Transaction Set Header	`ST01`	`856`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BSN`Beginning Segment for ship notice	`BSN01`	`00`
	`BSN02`	Shipment Identification
	`BSN03`	Ship Notice Creation Date (CCYYMMDD)
	`BSN04`	Ship Notice Creation time (HHMM)
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
`HL`Hierarchical level	`HL03`	`S` – shipment
`DTM`Date/Time Reference	`DTM01`	`011`
`DTM`Date/Time Reference	`DTM02`	Shipping Date (CCYYMMDD)
`TD5`Carrier Details	`TD505`	Carrier identity according to the accepted values (attached below)
`N1`Party Identification	`N101`	`SF` – Ship From
`N1`Party Identification	`N102`	Description (Name)
`N3`Address Information	`N301`	Address Information
`N4`Geographic Location	`N401`	City Name
`N4`Geographic Location	`N402`	State Code
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`O` – Order
`PRF`Purchase Order Reference	`PRF01`	Shipment Id
`PRF`Purchase Order Reference	`PRF02`	Order Number
`REF`Reference	`REF01`	`LS`
`REF`Reference	`REF02`	Master Barcode
`REF`Reference	`REF01`	`SE`
`REF`Reference	`REF02`	Serial Number
`REF`Reference	`REF01`	`LA`
`REF`Reference	`REF02`	SSCC-Container Barcode
HL02	`Tracking Number`	undefined
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`P` – Pack
`MAN`Tracking Number*	`MAN01`	`TN`
`MAN`Tracking Number*	`MAN02`	Tracking Number
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`I` – Item
`LIN`Item Identification	`LIN01`	Line Number
	`LIN02`	`ST`
	`LIN03`	Product Code
`SN1`Item Detail	`SN102`	Number of Units Shipped
`SN1`Item Detail	`SN103`	`EA`
`CTT`Transaction Totals	`CTT01`	`EA`Number of Line Items
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments
`SE`Transactions Set Trailers	`SE02`	Transaction Set Control Number

Download Example 856 B2C File More info

856–Advance Ship Notice (Retail)

Segment	Element	Value
`GS`Functional Groups Envelope	`GS01`	`SH`
	`GS06`	GS Number
	`GS8`	X12 Version
`ST`Transaction Set Header	`ST01`	`856`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BSN`Beginning Segment for ship notice	`BSN01`	`00`
	`BSN02`	Shipment Identification
	`BSN03`	Ship Notice Creation Date (CCYYMMDD)
	`BSN04`	Ship Notice Creation time (HHMM)
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
`HL`Hierarchical level	`HL03`	`S` – shipment
`TD1`Packing details for the total shipment	`TD101`	Packaging Code (like PLT94) Part 1 = PLT – Packaging Form Part 2 = 94 – Packaging Material if the Data Element is used, then Part 1 is always required Code list
	`TD102`	Lading Quantity – Number of units (pieces) of the lading commodity
	`TD106`	Weight Qualifier (`G` for Gross Weight) Code list
	`TD107`	Weight
	`TD108`	Unit or Basis for Weight Code list
`TD5`Carrier Details	`TD505`	Carrier identity according to the accepted values (attached below)
`DTM`Date/Time Reference	`DTM01`	`011`
`DTM`Date/Time Reference	`DTM02`	Shipping Date (CCYYMMDD)
`N1`Party Identification	`N101`	`SF` – Ship From
`N1`Party Identification	`N102`	Description (Name)
`N3`Address Information	`N301`	Address Information
`N4`Geographic Location	`N401`	City Name
`N4`Geographic Location	`N402`	State Code
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`O` – Order
`PRF`Purchase Order Reference	`PRF01`	Origin PO Number
`TD1`Packing details for unit	`TD101`	Packaging Code (like PLT94) Part 1 = PLT – Packaging Form Part 2 = 94 – Packaging Material if the Data Element is used, then Part 1 is always required Code list
`TD1`Packing details for unit	`TD102`	Lading Quantity – Number of units (pieces) of the lading commodity
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`P` – Pack
`MAN`Tracking Label	`HL01`	`TN`
`MAN`Tracking Label	`HL02`	Tracking Label
`HL`Hierarchical level	`HL01`	Hierarchical ID Number
	`HL02`	Hierarchical Parent ID Number
	`HL03`	`I` – Item
`LIN`Item Identification	`LIN01`	Line Number
	`LIN02`	`UP`
	`LIN03`	Product Code UPC
	`LIN04`	`SK`
	`LIN05`	Product Code SKU
	`LIN06`	`SH`
	`LIN07`	Shipment ID – Mandatory
	`LIN08`	`PO`
	`LIN09`	PO Number from Resident
`SN1`Item Detail	`SN102`	Number of Units Shipped
`SN1`Item Detail	`SN103`	`EA`
`REF`Reference	`REF01`	`LS`
`REF`Reference	`REF02`	Master Barcode
`REF`Reference	`REF01`	`SE`
`REF`Reference	`REF02`	Serial Number
`REF`Reference	`REF01`	`LA`
`REF`Reference	`REF02`	SSCC-Container Barcode
`CTT`Transaction Totals	`CTT01`	Number of Line Items
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments
`SE`Transactions Set Trailers	`SE02`	Transaction Set Control Number

Download Example 856 Retail File More info

860–Order Cancellation

Segment	Element	Value
`GS`Functional Groups Envelope	`GS`	`PC`
`ST`Transaction Set Header	`ST01`	`860`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BCH`Beginning Segment for Order Cancellation	`BCH01`	`01` – Full Cancellation
	`BCH02`	`CP`
	`BCH03`	Order Number
	`BCH06`	Date Time of Cancel
`REF`Shipment Id Identification	`REF01`	`PO`
`REF`Shipment Id Identification	`REF02`	Shipment ID (24 characters)
`CTT`Transaction Totals	`CTT01`	Number of Line Items
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments
`SE`Transactions Set Trailers	`SE02`	Transaction Set Control Number

Download Example 860 File More info

865–Purchase Order Change Acknowledgement

Segment	Element	Value
`GS`Functional Groups Envelope	`GS`	`CA`
`ST`Transaction Set Header	`ST01`	`865`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BCA`Beginning Segment	`BCA01`	`00`
	`BCA02`	`AT` – Accepted `RJ` – Rejected
	`BCA03`	Shipment ID (from Resident’s order) Should look like: 61c3417520000050003d2982
	`BCA06`	Date (CCYYMMDD)
`N9`Rejected Reason	`N303`	If BCA02 is `RJ` then please add a free text reason here.
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments
`SE`Transactions Set Trailers	`SE02`	Transaction Set Control Number

Download Example 865 File More info

846–Inventory Report

Segment	Element	Value
`GS`Functional Groups Envelope	`GS`	`IB`
`ST`Transaction Set Header	`ST01`	`846`
`ST`Transaction Set Header	`ST02`	Transaction Set Control Number
`BIA`Beginning Segment for Inventory	`BIA01`	`00`
	`BIA02`	`SI` – Inventory Report
	`BIA03`	Reference Notification
	`BIA04`	Inventory Date (CCYYMMDD)
`N1`Party Identification	`N101`	`WH` – Warehouse
`N1`Party Identification	`N102`	Description
`LIN`Baseline Item Data	`LIN101`	Assigned Identification
	`LIN102`	`ST`
	`LIN103`	Product Code
`QTY`Quantity	`QTY01`	`33` – Quantity Available for sale
`QTY`Quantity	`QTY02`	Quantity
`DTM`Date of planned availability	`DTM01`	`169`
`DTM`Date of planned availability	`DTM02`	ETA Date (CCYYMMDD)
`CTT`Transaction Totals	`CTT01`	Number of Line Items
`SE`Transactions Set Trailers	`SE01`	Number of Included Segments
`SE`Transactions Set Trailers	`SE02`	Transaction Set Control Number

Download Example 846 File More info

Need help connecting?

Our support team will guide you through setting up the interface.

Contact support

EDI communication in X12

What is EDI or X12?

How does it work?

Documents at a glance

850–Purchase Order (B2C)

850–Purchase Order (Retail)

855 – Orders Acknowledgment

856–Advance Ship Notice (B2C)

856–Advance Ship Notice (Retail)

860–Order Cancellation

865–Purchase Order Change Acknowledgement

846–Inventory Report

Need help connecting?