Skip to main content
Home
  • AI Mode
  • Supply Chain Orchestration
    fast
    Supply Chain Orchestration
    • Life Sciences Company
    • Direct Material Supplier
    • Contract Manufacturer
    • Third Party Logistics
    • Wholesale Distributor
    • Healthcare Provider
    • Retail Pharmacy
  • Network
  • Products
    fast
    Products
    • Multienterprise Information Network Tower (MINT)
    • Process Orchestration for Empowered Teams (POET)
    • Track-and-Trace
  • Resources
    fast
    Resources
    • Resource Center
    • TraceLink University
    • Partners
    • Community
    • Events
  • About
    fast
    About
    • Our Story
    • Newsroom
    • Culture and Careers
    • Leadership
    • Our Values
    • Corporate Social Responsibility
    • Contact Sales
  • Log In
    • Tracelink Classic
      TraceLink Classic app.tracelink.com
      Redirect
    • Opus Platform
      Opus Platform opus.tracelink.com
      Redirect
Log In
  • Tracelink Classic
    TraceLink Classic app.tracelink.com
    Redirect
  • Opus Platform
    Opus Platform opus.tracelink.com
    Redirect
Tracelink University

Breadcrumb

  1. Home
  2. Resources
  3. TraceLink University

Organizational relationship (X12)

  • Download PDF
  • Share
    • LinkedIn
    • Facebook
    • Mail
    • Twitter

Table of contents

The Organizational Relationships transaction is a master data message used to share structured information about organizational hierarchies, relationships, and identifiers between trading partners. It defines how companies, business units, and locations relate to one another—such as parent–subsidiary, company–location, or owner–partner relationships—and includes key data such as names, addresses, contacts, and identifiers like GLNs, DUNS numbers, or internal codes.

An Organizational Relationship in X12 format is a structured way to represent the association between business entities using standardized identifiers and relationship codes within an EDI transaction.

Contact your TraceLink Services representative for more information about integrating with this message.

  • Message Type: MPC_ORGANIZATIONAL_RELATIONSHIP
  • X12 Format: ORGANIZATIONALRELATIONSHIP
  • Transform Names:
    • B2B_EDI_X12_816_OrganizationalRelationships_IB_V1

    • B2B_EDI_X12_816_OrganizationalRelationship_OB_V1

ClosedGuidelines
Input Element Occurs Length Description Example
ISA 1…1 - Required. ISA interchange envelope. -
  ISA01 1…1 2/2 Required. Qualifier for authorization control number in ISA02. 00
  ISA02 1…1 10/10 Required. Information used for additional identification or authorization of the interchange sender or the data in the interchange/ 10 spaces a valid entry. -
  ISA03 1…1 2/2 Required. Qualifier for security information in ISA04. 00
  ISA04 1…1 10/10 Required. Identifies security information about the interchange sender or data. -
  ISA05 1…1 2/2

Required. Interchange sender partner ID qualifier.

ClosedValid values:
  • 01 – Duns (Dun & Bradstreet).
  • 02 – Standard Carrier Alpha Code.
  • 03 – Federal Maritime Commission.
  • 04 – International Air Transport Association.
  • 07 – Global Location Number (GLN).
  • 08 – UCC EDI Communications ID (Comm ID).
  • 09 – X.121 (CCITT).
  • 10 – Department of Defense (DoD) Activity Address Code.
  • 11 – Drug Enforcement Administration identifier.
  • 12 – Telephone Companies.
  • 13 – Used for UCS Transmissions. Includes Area Code and Telephone Number of a Modem.
  • 14 – Duns Plus Suffix.
  • 15 – Petroleum Accountants Society of Canada Company Code.
  • 16 – DINS Number With 4-Character Suffix.
  • 17 – American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit).
  • 18 – Association of American Railroads (AAR) Standard Distribution Code.
  • 19 – EDI Council of Australia (EDICA) Communications ID Number (COMM ID).
  • 20 – Health Industry Number (HIN).
  • 21 – Integrated Postsecondary Education Data System.
  • 22 – Federal Interagency Commission on Education, or FICE.
  • 23 – National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes.
  • 24 – The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP.
  • 25 – 4-Digit Code of Postsecondary Institutions.
  • 26 – Statistics of Canada List of Postsecondary Institutions.
  • 27 – Carrier Identification Number as assigned by Health Care Financing Administration (HCFA).
  • 28 – Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA).
  • 29 – Medicare Provider and Supplier Identification Number assigned by Health Care Financing Administration (HCFA).
  • 30 – U.S. Federal Tax Identification Number.
  • 31 – Jurisdiction Identification Number Plus 4 assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC).
  • 32 – U.S. Federal Employer Identification Number (FEIN).
  • 33 – National Association of Insurance Commissioners Company Code (NAIC).
  • 34 – Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA).
  • 35 – Statistics Canada Canadian College Student Information System Institution Codes
  • 36 – Statistics Canada University Student Information System Institution Codes.
  • 37 – Society of Property Information Compilers and Analysts (SPICA).
  • 38 – The College Board and ACT, Inc. 6-Digit Code List of Secondary Institutions.
  • AM – Association Mexicana del Codigo de Producto (AMECOP) Communication ID.
  • NR – National Retail Merchants Association (NRMA) - Assigned.
  • SA – User Identification Number as assigned by the Safety and the Fitness Electronic Records (SAFER) System.
  • SN – Standard Address Number.
  • ZZ – Mutually Defined.
07
  ISA06 1…1 15/15

Required. Interchange sender identification mapping to:

  • fileSenderNumber with party type defined in ISA05.

  • linkIdentifier

  • x12InterchangeControlEnvelope for sender in X12 control file header.

7777776067344
  ISA07 1…1 2/2

Required. Interchange receiver partner ID qualifier.

ClosedValid values:
  • 01 – Duns (Dun & Bradstreet).
  • 02 – Standard Carrier Alpha Code.
  • 03 – Federal Maritime Commission.
  • 04 – International Air Transport Association.
  • 07 – Global Location Number (GLN).
  • 08 – UCC EDI Communications ID (Comm ID).
  • 09 – X.121 (CCITT).
  • 10 – Department of Defense (DoD) Activity Address Code.
  • 11 – Drug Enforcement Administration identifier.
  • 12 – Telephone Companies.
  • 13 – Used for UCS Transmissions. Includes Area Code and Telephone Number of a Modem.
  • 14 – Duns Plus Suffix.
  • 15 – Petroleum Accountants Society of Canada Company Code.
  • 16 – DINS Number With 4-Character Suffix.
  • 17 – American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit).
  • 18 – Association of American Railroads (AAR) Standard Distribution Code.
  • 19 – EDI Council of Australia (EDICA) Communications ID Number (COMM ID).
  • 20 – Health Industry Number (HIN).
  • 21 – Integrated Postsecondary Education Data System.
  • 22 – Federal Interagency Commission on Education, or FICE.
  • 23 – National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes.
  • 24 – The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP.
  • 25 – 4-Digit Code of Postsecondary Institutions.
  • 26 – Statistics of Canada List of Postsecondary Institutions.
  • 27 – Carrier Identification Number as assigned by Health Care Financing Administration (HCFA).
  • 28 – Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA).
  • 29 – Medicare Provider and Supplier Identification Number assigned by Health Care Financing Administration (HCFA).
  • 30 – U.S. Federal Tax Identification Number.
  • 31 – Jurisdiction Identification Number Plus 4 assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC).
  • 32 – U.S. Federal Employer Identification Number (FEIN).
  • 33 – National Association of Insurance Commissioners Company Code (NAIC).
  • 34 – Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA).
  • 35 – Statistics Canada Canadian College Student Information System Institution Codes
  • 36 – Statistics Canada University Student Information System Institution Codes.
  • 37 – Society of Property Information Compilers and Analysts (SPICA).
  • 38 – The College Board and ACT, Inc. 6-Digit Code List of Secondary Institutions.
  • AM – Association Mexicana del Codigo de Producto (AMECOP) Communication ID.
  • NR – National Retail Merchants Association (NRMA) - Assigned.
  • SA – User Identification Number as assigned by the Safety and the Fitness Electronic Records (SAFER) System.
  • SN – Standard Address Number.
  • ZZ – Mutually Defined.
01
  ISA08 1…1 15/15

Required. EDI receiver ID mapping to file control header and to ServiceLinkId.

Interchange receiver identification mapping to ediInterchangePartyValue for receiver in X12 control file header.

888888404358877
  ISA09 1…1 6/6 Required. Interchange date in 6 char YYMMDD format. 231020
  ISA10 1…1 4/4 Required. Interchange time in 4 char HHMM format. 1420
  ISA11 1…1 1/1

Required. This value is dependent on X12 version.

  • Version 4012 and earlier, this is the interchange control standards identifier. Valid value is U.

  • Version 4020 and later, this is the repetition separator, a delimiter that separates repeated occurrences of a data element or composite data structure, which must be different than the data element separator, component separator, and segment terminator."

^
  ISA12 1…1 5/5 Required. Interchange control version number. This could be any X12 version. 00501
  ISA13 1…1 9/9

Required. Interchange Control Number mapping to:

  • file control header

  • X12 control file header interchangeControlIdentifier

0000000000619827
  ISA14 1…1 1/1

Required. Interchange level acknowledgment requested.

Valid values:

  • 0 - No acknowledgment requested

  • 1 - Interchange level acknowledgment requested

0
  ISA15 1…1 1/1

Required. Indicates whether the interchange is for production, test, or information purposes.

Valid values:

  • I - Information

  • P - Production data

  • T - Test data

P
  ISA16 1…1 1/1 Required. Component element separator. Delimiter that separates data elements within a composite data structure. Must be different than the data element separator and segment terminator. >
GS 1…* - GS group functional envelope. Child of ISA. Only one GS group expected per interchange. -
  GS01 1…1 2/2 Required. GS group function code. Valid value is AGShipping instruction Information. AG
  GS02 1…1 2/15 Required. Application Sender's Code. 2222224043588
  GS03 1…1 2/15 Required. Application Receiver's Code. TRACELINK
  GS04 1…1 8/8 Required. Current date stamp in 8 char X12 date format YYYYMMDD. 20241020
  GS05 1…1 4/8 Required. Current time stamp in 6 char X12 time format HHMMSS. 142000
  GS06 1…1 1/9 Required. Group Control ID Number. 619827
  GS07 1…1 1/2

Required. Responsible Agency Code.

Valid values:

  • T - Transportation Data Coordinating Committee (TDCC)

  • X - Accredited Standards Committee X12

X
  GS08 1…1 1/12 Required. X12 message version code. This could be any X12 version. 005010
ST 1…* - ST transaction set envelope. Child of GS group. Only one ST transaction expected. -
  ST01 1…1 3/3 Required. Transaction set identifier code. 816
  ST02 1…1 4/9 Required. Transaction set ID number. Counter for each ST segment beginning with 1. 0001
  BHT 1…1 - Required. BGN Beginning Segment. -
    BHT01 1…1 4/4

Required. Identifies the type of hierarchical structure applied in the transaction, defining how hierarchical levels are related to one another.

Valid values:

  • 0065 - Structure type is company and its operating unit.

  • 0057 - Structure type is supergroup its subgroup and member

0065
    BHT02 1…1 2/2

Required. Transaction Set Purpose Code identifying purpose of transaction set.

ClosedValid values:
  • 00 – Original document, create in target.
  • 01 – Cancel order.
  • 02 – Create document or item from message.
  • 03 – Delete document or item.
  • 04 – Changes to document header.
  • 05 – Replace entire document.
  • 06 – Document is a confirmation.
  • 07 – Duplicate transaction.
  • 08 – Document or item status.
  • 11 – Response message.
  • 13 – Request message.
  • 16 – Proposed document or item.
  • 17 – Message canceled and reissued.
  • 22 – Information only.
  • 24 – Document is in draft state.
  • 45 – Followup message.
  • CO – Document or item has been corrected.
00
    BHT03 0…1 1/80 Reference identifier defined for a particular transaction set. The sender's internal number used to identify this transaction set within the sender's application system. 8475
    BHT04 0…1 8/8 Date the original transaction was generated in the sender's business application system, in X12 date format YYYYMMDD. 20160129
    BHT05 0…1 4/8 Transaction time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD. 223344
  DTM 0...* - Transaction document date or other header level dates. -
    DTM01 1…1 3/3

Required. Date type related to shipment events at port, in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

ClosedValid values:
  • 002 - Delivery requested by date

  • 003 - Invoice date

  • 004 - Purchase order date

  • 007 - Effective date

  • 008 - Purchase order received date

  • 009 - Processing date

  • 010 - Shipment requested by date

  • 011 - Date shipped

  • 015 - Promotion start date

  • 016 - Promotion end date

  • 017 - Estimated delivery date

  • 018 - Product availability date

  • 020 - Check date

  • 023 - Promotion order start date

  • 024 - Promotion order end date

  • 025 - Promotion ship start date

  • 026 - Promotion ship end date

  • 035 - Date of delivery document, ASN

  • 036 - Expiration date

  • 037 - Not before shipment date

  • 038 - Not later shipment date

  • 040 - Status (After and Including)

  • 041 - Status (Prior and Including)

  • 050 - Date goods receipt posted (received into available inventory)

  • 058 - Customs Clearance date

  • 061 - Cancel by date

  • 067 - Current scheduled delivery date

  • 068 - Scheduled shipment date

  • 069 - Date of promised delivery

  • 070 - Delivery schedule date

  • 074 - Requested delivery date

  • 079 - Promised for shipment date

  • 090 - Report start date

  • 091 - Report end date

  • 092 - Contract effective date

  • 093 - Contract expiration date

  • 094 - Manufacturing date

  • 097 - Transactional date creation

  • 102 - Date goods issue posted

  • 133 - Account receivable date

  • 139 - Estimated

  • 140 - Actual date

  • 146 - Closing date

  • 161 - Loaded on vessel date

  • 166 - Message date

  • 168 - Release date

  • 184 - Inventory Update date

  • 188 - Credit advice date

  • 189 - Debit advise date

  • 196 - Date Start

  • 197 - End date

  • 208 - Lot expiration date

  • 311 - Latest receiving / cutoff date

  • 324 - Returned date

  • 369 - Estimated Departure Date

  • 370 - Actual Departure date

  • 371 - Estimated Arrival date

  • 372 - Actual arrival date

  • 472 - Date services rendered

  • 510 - Date packed

  • 512 - Warranty date

  • 514 - Transfer date

  • 649 - Document due date

  • 813 - Customs entry date

  • 814 - Payment due date

  • 922 - Date of original receipt

  • 938 - Order date

  • 964 - Billing date

  • 999 - Document date

  • AAG - Due date

  • VLU - Validity date

999
    DTM02 0…1 8/8 Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. 20241215
    DTM03 0…1 4/8 Time expressed in 24-hour clock time as follows. -
    DTM04 0…1 2/2 Time zone for referenced dates. ES
    DTM05 0…1 2/3

Describes the date format, time format, or date and time period format type.

ClosedValid values:
  • D6 - YYMMDD

  • D8 - CCYYMMDD

  • DD - DAYOFMONTH

  • DT - CCYYMMDDHHMM

  • MD - MMDD

  • T - MMDDYY

  • TM - HHMM

  • TQ - MMYY

  • TS - HHMMSS

  • TT - MMDDYY

  • YM - YYMM

DT
    DTM06 0…1 1/35 Describes the date format, time format, or date and time period. -
  REF(1) 0…100 - Reference segment for mapping to the transaction reference identifiers. -
    REF01 1…1 2/3

Required. Reference identification qualifier for the contract class.

ClosedValid values:
  • 10 - Consolidated Shipment Number
  • 14 - Master account

  • 1X - Credit debit adjustment identifier type

  • 2I - Tracking number

  • 72 - Schedule reference identifier

  • 92 - Document change Tracking number

  • A3 - Assignment

  • AG - Agent's sipment identifier

  • AM - Chargeback adjustment memo

  • BAF - Receipt number

  • BC - Customer contract number

  • BL - Government Bill of Lading

  • BM - Bill of lading

  • BT - Batch

  • CB - Combined Shipment

  • CD - Credit advice

  • CG - Conginee order number

  • CK - Check number

  • CM - Credit memo

  • CN - Carrier reference

  • CO - Customer order number, Identifies the number assigned by the customer to their order.

  • CR - Customer reference identifier

  • CT - Contract number

  • D1 - US Drug Enforcement Agency (DEA) order number

  • DD - Document number

  • DEA - DEA certificate identifier

  • DH - DEA identifier number

  • DI - Distributor invoice number

  • DL - Debit memo

  • DO - Delivery

  • EM - Electronic payment

  • GK - Third party reference identifier

  • IB - Customs regulatory document identifier for shipments transiting under bond

  • IK - Invoice party reference identifier

  • IN - Consignee's Invoice Number

  • IV - Seller's invoice

  • K9 - Customer inquiry number

  • MA - Ship notice or manifest number for shipment

  • MB - Master bill of lading

  • OI - Original invoice

  • OQ - Order number

  • P2 - Previous DEA identifier number

  • PK - Packing list number

  • PO - Purchase order number

  • PP - Purchase order revision number

  • PR - Price quote number

  • PT - Purchase Option Agreement

  • Q1 - Supplier quotation number

  • QD - DEA replacement identifier number

  • QP - Original purchase order number

  • RE - Release document number

  • RZ - Return authorization transaction identifier type

  • SI - Shipment number

  • SN - Seal number

  • SO - Shipper's Order (Invoice Number)

  • TB - Trucker's Bill of Lading

  • TN - Transaction reference number

  • VAT - VAT Number

  • VC - Supplier contract number

  • VN - Supplier order number

  • VR - Vendor identifier number

  • WH - Master Reference (Link) Number

  • WO - Work order (production order) number

CT
    REF02 0…1 1/80 Reference identifier value. 123456
    REF03 0…1 1/80 Description defined by qualifier code in REF02. sub-340B
  REF(2) 0…30 - Reference segment for mapping to the transaction references. -
    REF01 1…1 2/3

Required. Reference identification qualifier for the contract class.

ClosedValid values:
  • 10 - Consolidated Shipment Number
  • 14 - Master account

  • 1X - Credit debit adjustment identifier type

  • 2I - Tracking number

  • 72 - Schedule reference identifier

  • 92 - Document change Tracking number

  • A3 - Assignment

  • AG - Agent's sipment identifier

  • AM - Chargeback adjustment memo

  • BAF - Receipt number

  • BC - Customer contract number

  • BL - Government Bill of Lading

  • BM - Bill of lading

  • BT - Batch

  • CB - Combined Shipment

  • CD - Credit advice

  • CG - Conginee order number

  • CK - Check number

  • CM - Credit memo

  • CN - Carrier reference

  • CO - Customer order number, Identifies the number assigned by the customer to their order.

  • CR - Customer reference identifier

  • CT - Contract number

  • D1 - US Drug Enforcement Agency (DEA) order number

  • DD - Document number

  • DEA - DEA certificate identifier

  • DH - DEA identifier number

  • DI - Distributor invoice number

  • DL - Debit memo

  • DO - Delivery

  • EM - Electronic payment

  • GK - Third party reference identifier

  • IB - Customs regulatory document identifier for shipments transiting under bond

  • IK - Invoice party reference identifier

  • IN - Consignee's Invoice Number

  • IV - Seller's invoice

  • K9 - Customer inquiry number

  • MA - Ship notice or manifest number for shipment

  • MB - Master bill of lading

  • OI - Original invoice

  • OQ - Order number

  • P2 - Previous DEA identifier number

  • PK - Packing list number

  • PO - Purchase order number

  • PP - Purchase order revision number

  • PR - Price quote number

  • PT - Purchase Option Agreement

  • Q1 - Supplier quotation number

  • QD - DEA replacement identifier number

  • QP - Original purchase order number

  • RE - Release document number

  • RZ - Return authorization transaction identifier type

  • SI - Shipment number

  • SN - Seal number

  • SO - Shipper's Order (Invoice Number)

  • TB - Trucker's Bill of Lading

  • TN - Transaction reference number

  • VAT - VAT Number

  • VC - Supplier contract number

  • VN - Supplier order number

  • VR - Vendor identifier number

  • WH - Master Reference (Link) Number

  • WO - Work order (production order) number

IA
    REF02 0…1 1/80 Reference identifier value. 123456
    REF03 0…1 1/80 Description defined by qualifier code in REF02. -
  N1 Loop 1…* - N1 segment loop at header for party address and reference information. -
    N1 1…1 - Required. Party identification. -
      N101 1…1 2/3

Required. Entity qualifier for the Sender or Receiver party identifier and address information.

Closed Valid values:
  • AO – Account of party
  • BK - Bank
  • BG - Purchasing group, buying group
  • BS – Billto and Shipto combined
  • BT – Billto party
  • BY – Customer, Buyer, sold to party
  • CA – Carrier (transport operator)
  • CI – Consignor
  • CN – Consignee
  • CL – Container location
  • CQ - Corportate office
  • C9 – Contract holder or contractor
  • DA – Delivery address / party
  • DB - Distributor branch location
  • DS - Distributor party or location
  • DT – Destination terminal
  • D1 – Truck driver (no EDI qualifier, contextbased)
  • EX - Exporter
  • FR - Message sender
  • HA - Owner of goods
  • FW - Freight forwarder
  • L8 - Head office location
  • MA - Final customer
  • MF - Manufacturer
  • NP - Notify party
  • N1 - First notify party
  • N2 - Second notify party
  • N3 - Third notify party
  • OB - Ordered by party
  • OE - Booking office
  • OT - Origin inland terminal
  • PE - Party that will receive invoice, the payee
  • PO - Party to receive invoice for goods or services
  • PR - Person or organization that pays the invoice
  • PW - Pickup location
  • QA - Retail or institutional pharmacy dispenser. Also used for contracted third party pharmacy supporting a 304b covered entitty.
  • RO - Origin intermodal ramp
  • R1 - The party that receives the document containing weight information fromn the scale.
  • RD - Destination intermodal ramp
  • RL - Reporting party/location / WMS provider (Danone)
  • SF - Shipfrom location
  • SI - Business party that issues the shipping instruction
  • SN - Store number with location info for store
  • SH - Shipper
  • ST - Shipto location
  • SU - Supplier
  • TO - Message receiver
  • VN - Vendor (alt. seller)
  • VI - Contact person information
  • WH - Warehouse
  • YE - Third party business or location information. Also used to identify third party logistics service provider.
  • 2P - Public health service facility: 304B entity that tales ownership of a product in the original sale.
  • 13 - Contracted third party service provider. Also used for third-party contracted pharmacy supporting a 340B covered entity.
  • 41 - Partner or business entity group initiates the transaction
SU
      N102 0…1 1/60 Name. Pharma customer
      N103 0…1 1/2

Identifier code qualifier.

Valid values:

  • 1 - D-U-N-S number, Dun and Bradstreet

  • 9 - D-U-N-S + 4r, Dun and Bradstreet number plus suffix

  • 11 - Drug Enforcement Agency registration number

  • 21 - Health Industry Number

  • 25 - Carrier customer code

  • 91 - Company identifier

  • 92 - Company location identifier

  • 93 - Transaction set sender

  • 94 - Transaction set receiver

  • UL - Global Location Number

UL
      N104 0…1 2/80 Party identifier as qualified by N103 mapping to companyIdentifierValue. 3333331013655
    N2 0…2 - N2: Additional names: Child of customer party N1 name segment., we do support one iteration of N2. -
      N201 1…1 1/60 Required. Additional name 2. Pharma name2
      N202 0…1 1/60 Additional name 2. Pharma name2
    N3 0…2 - N3: Address: Child of customer party N1 name segment. -
      N301 1…1 1/55 Required. Street address 1. 555 Neelan Road
      N302 0…1 1/55 Street address 2. Suite 123
    N4 0…1 - N4: Geographic Location. Child of customer party N1 name segment. -
      N401 0…1 2/30 City name. Sacramento
      N402 0…1 2/2 State or province code. Code (Standard state/province) as defined by appropriate government agency. CA
      N403 0…1 3/15 Postal code. Code defining international postal zone code excluding punctuation and blanks. 95833
      N404 0…1 2/3 Country code. US
      N405 0…1 1/2 Type of location. CA
      N406 0…1 1/30 Specific location. 95833
      N407 0…1 1/3 Country subdivision. US
    REF(1) 0…12 - Reference segment for mapping to the transaction reference identifiers. -
      REF01 1…1 2/3

Required. Reference identification qualifier for the contract class.

ClosedValid values:
  • 10 - Consolidated Shipment Number
  • 14 - Master account

  • 1X - Credit debit adjustment identifier type

  • 2I - Tracking number

  • 72 - Schedule reference identifier

  • 92 - Document change Tracking number

  • A3 - Assignment

  • AG - Agent's sipment identifier

  • AM - Chargeback adjustment memo

  • BAF - Receipt number

  • BC - Customer contract number

  • BL - Government Bill of Lading

  • BM - Bill of lading

  • BT - Batch

  • CB - Combined Shipment

  • CD - Credit advice

  • CG - Conginee order number

  • CK - Check number

  • CM - Credit memo

  • CN - Carrier reference

  • CO - Customer order number, Identifies the number assigned by the customer to their order.

  • CR - Customer reference identifier

  • CT - Contract number

  • D1 - US Drug Enforcement Agency (DEA) order number

  • DD - Document number

  • DEA - DEA certificate identifier

  • DH - DEA identifier number

  • DI - Distributor invoice number

  • DL - Debit memo

  • DO - Delivery

  • EM - Electronic payment

  • GK - Third party reference identifier

  • IB - Customs regulatory document identifier for shipments transiting under bond

  • IK - Invoice party reference identifier

  • IN - Consignee's Invoice Number

  • IV - Seller's invoice

  • K9 - Customer inquiry number

  • MA - Ship notice or manifest number for shipment

  • MB - Master bill of lading

  • OI - Original invoice

  • OQ - Order number

  • P2 - Previous DEA identifier number

  • PK - Packing list number

  • PO - Purchase order number

  • PP - Purchase order revision number

  • PR - Price quote number

  • PT - Purchase Option Agreement

  • Q1 - Supplier quotation number

  • QD - DEA replacement identifier number

  • QP - Original purchase order number

  • RE - Release document number

  • RZ - Return authorization transaction identifier type

  • SI - Shipment number

  • SN - Seal number

  • SO - Shipper's Order (Invoice Number)

  • TB - Trucker's Bill of Lading

  • TN - Transaction reference number

  • VAT - VAT Number

  • VC - Supplier contract number

  • VN - Supplier order number

  • VR - Vendor identifier number

  • WH - Master Reference (Link) Number

  • WO - Work order (production order) number

CT
      REF02 0…1 1/80 Reference identifier value: 123456
      REF03 0…1 1/80 Description defined by qualifier code in REF02. sub-340B
    REF (2) 0…12 - Reference segment for mapping to the transaction references. -
      REF01 1…1 2/3

Required. Reference identifier qualifier. Code identifies the type of ID number sent in REF02. For Wal-Mart, qualifier IA is required for their internal vendor number.

ClosedValid values
  • 11 - Account Number

  • 14 - Master account number

  • 19 - Division identifier

  • 33 - Lender Case Number

  • 87 - Functional category

  • 1J - Facility ID Number

  • 1W - Group purchasing organization member identifier

  • 2I - Tracking Number

  • 2U - Payer Identification number for 340B programs

  • 3Y - Receiver Assigned Drop Zone

  • 4F - Carrier-assigned Shipper Number

  • 4N - Special Payment Reference Number

  • 6A - Consignee reference

  • 6L - Agent contract number

  • 6O - Cross Reference number

  • 7W - Interchange Train Identification

  • 8V - A credit reference number is a credit memo issued on the return of an original invoice number

  • 8X - Transaction Category

  • 9F - Referral Number

  • 9V - Payment Category

  • 9X - Account type/category

  • AAL - Booking agent reference

  • AAO - Carrier Assigned Code

  • ABS - Vessel Name

  • ACC - Status

  • ACD - Class Code

  • ACT - Accounting Code

  • ADI - Processor Identification Number

  • ADT - Full Denial Reason Identifier

  • AEM - Distribution center identifier

  • AF - Airlines Flight Identification Number

  • AHC - Air Handling Code

  • AO - Appointment Number

  • AW - Air way bill Number

  • BN - Booking number

  • BP - Adjustment control number

  • BS - Split booking reference number

  • C8 - Corrected contract number

  • CC - Collect Loads or Contract Co-op Number

  • CE - Class of contract code

  • CQ - Customs house broker license number

  • CR - Customer reference Number

  • CT - Contract number

  • DH - US Drug Enforcement agency identifier

  • DI - Distributor Invoice Number

  • DJ - Delivery ticket number as reference from shippers / carrier / consignees system

  • DNS - DUNS number with four character suffix

  • DP - Department identifier

  • DQ - Delivery Quote Number

  • E7 - Service Bulletin Number

  • ED - Customs export declaration reference Number

  • EP - Export License Number

  • EQ - Equipment number

  • EVI - Event Identification

  • FI - File Identifier

  • FN - Freight forwarder reference identifier

  • GT - Goods and service tax registration number

  • HI - US Health Industry Number

  • HR - Horsepower

  • HS - Harmonized code system (Canada)

  • IA - Internal vendor Number

  • IT - Internal customer number

  • IX - Item number

  • JH - Other tag number

  • KK - Proof Of Delivery

  • KL - Contract reference number

  • L1 - Letters or notes

  • LI - Line item number

  • LO - Load planning reference number

  • LT - Lot or batch number

  • LU - GS1-US Global Location Number (GLN)

  • MH - Manufacturing order number

  • MR - Merchandise type code

  • MTI - Master Tracking Number

  • NB - Letter of credit Number

  • OC - Ocean container number

  • OD - Original Return Request Reference Number

  • ON - Buyer assigned order identifier number

  • OT - Sales Allowance Number

  • P1 - Previous contract number

  • P2 - Previous DEA identifier

  • P3 - Previous HIN identifier

  • P7 - Product line number

  • P8 - Pickup reference number

  • PD - Promotion deal number

  • PE - Plant number

  • PHC - Process Handling Code

  • PRT - Product Type

  • Q8 - Company/place registration number

  • QN - Stop Sequence Number

  • QY - Express Service Code

  • RA - Repetitive Shipment Number

  • RF - Export reference number (not a licence number)

  • RU - Route Number

  • RX - Resubmit Number

  • RY - Rebate reference number

  • RZ - Returned goods authorization Number

  • RZ - Return goods authorization

  • SB - Sales Region Number

  • SCA - Standard Carrier Alpha Code (SCAC)

  • SE - Serial Number

  • SI - Shipper's Identifying Number for Shipment

  • ST - store number

  • SZ - Specification Revision

  • TD - Reason for change recorded for order

  • TG - Transportation control number

  • TS - Tariff reference number

  • VA - Vessel agent number

  • VN - Vendor order number referencing customer purchase order, ie, vendor sales order

  • VR - Internal vendor identifier

  • VT - Motor vehicle identification number

  • VX- VAT Registration identifier

  • X8 - Secondary class identifier

  • XX2 - Service Area Code

  • ZH - Carrier assigned reference / booking number

  • ZZ - Mutually defined transaction identifier

  • ZZ - Customer or mutually defined transaction identifier (DEPRECATED)

IA
      REF02 0…1 1/80 Reference identifier value: 123456
      REF03 0…1 1/80 Description defined by qualifier code in REF02. -
    PER 0…3 - PER segment explains about contact information for party business or location. -
      PER01 1…1 2/2

Required. Contact type.

Valid values:

  • IC - Information contact

  • FC - Forwarder contact

  • RP - Responsible contact

IC
      PER02 0…1 1/60 Contact name. Grame Smith
      PER03 0…1 2/2 Communication qualifier. TE
      PER04 0…1 1/2048 Contact phone number. '897654
      PER05 0…1 2/2 Communication qualifier. EM
      PER06 0…1 1/2048 Contact email address. gsmith@gmail.com
  HL Loop 1…* - Line item loop start for Organizational relationship, referring a line number in a transaction set. -
    HL 1…1 - Required. Organizational hierarchical level for to denote its reporting level. -
      HL01 1…1 1/12 Required. Hierarchical level counter. Increment each instance by 1 from the last. 1
      HL02 0…1 1/12 Hierarchical identifier for the parent level of the current level. If there is no parent level this value would be the same as the current hierarchicalIdentifier. 2
      HL03 1…1 1/2

Required. Code identifying the hierarchical level of the hierarchical group in the organization .

Valid values:

  • 35 - Company or corporate level

  • BE - Business entity level

  • 24 - Super group level

  • 36 - Operating unit, such as store, warehouse

35
      HL04 0…1 1/1

Code indicating if there are child data segments subordinate to the current HL level.

Valid values:

  • 1 - a child line item segment follows

  • 0 - no child line item segment follows

1
    N1 Loop 1…* - N1 segment loop at items for organizational entities relationships and address and reference information. -
      N1 1…1 - Required. Party identification. -
        N101 1…1 2/3

Required. Entity qualifier for the Sender or Receiver party identifier and address information.

Closed Valid values:
  • AO – Account of party
  • BK - Bank
  • BG - Purchasing group, buying group
  • BS – Billto and Shipto combined
  • BT – Billto party
  • BY – Customer, Buyer, sold to party
  • CA – Carrier (transport operator)
  • CI – Consignor
  • CN – Consignee
  • CL – Container location
  • CQ - Corportate office
  • C9 – Contract holder or contractor
  • DA – Delivery address / party
  • DB - Distributor branch location
  • DS - Distributor party or location
  • DT – Destination terminal
  • D1 – Truck driver (no EDI qualifier, contextbased)
  • EX - Exporter
  • FR - Message sender
  • HA - Owner of goods
  • FW - Freight forwarder
  • L8 - Head office location
  • MA - Final customer
  • MF - Manufacturer
  • NP - Notify party
  • N1 - First notify party
  • N2 - Second notify party
  • N3 - Third notify party
  • OB - Ordered by party
  • OE - Booking office
  • OT - Origin inland terminal
  • PE - Party that will receive invoice, the payee
  • PO - Party to receive invoice for goods or services
  • PR - Person or organization that pays the invoice
  • PW - Pickup location
  • QA - Retail or institutional pharmacy dispenser. Also used for contracted third party pharmacy supporting a 304b covered entitty.
  • RO - Origin intermodal ramp
  • R1 - The party that receives the document containing weight information fromn the scale.
  • RD - Destination intermodal ramp
  • RL - Reporting party/location / WMS provider (Danone)
  • SF - Shipfrom location
  • SI - Business party that issues the shipping instruction
  • SN - Store number with location info for store
  • SH - Shipper
  • ST - Shipto location
  • SU - Supplier
  • TO - Message receiver
  • VN - Vendor (alt. seller)
  • VI - Contact person information
  • WH - Warehouse
  • YE - Third party business or location information. Also used to identify third party logistics service provider.
  • 2P - Public health service facility: 304B entity that tales ownership of a product in the original sale.
  • 13 - Contracted third party service provider. Also used for third-party contracted pharmacy supporting a 340B covered entity.
  • 41 - Partner or business entity group initiates the transaction
SU
        N102 0…1 1/60 Name. Pharma customer
        N103 0…1 1/2

Identifier code qualifier.

Valid values:

  • 1 - D-U-N-S number, Dun and Bradstreet

  • 9 - D-U-N-S + 4r, Dun and Bradstreet number plus suffix

  • 11 - Drug Enforcement Agency registration number

  • 21 - Health Industry Number

  • 25 - Carrier customer code

  • 91 - Company identifier

  • 92 - Company location identifier

  • 93 - Transaction set sender

  • 94 - Transaction set receiver

  • UL - Global Location Number

UL
        N104 0…1 2/80 Party identifier as qualified by N103 mapping to companyIdentifierValue. 3333331013655
      N2 0…2 - N2: Additional names: Child of customer party N1 name segment., we do support one iteration of N2. -
        N201 1…1 1/60 Required. Additional name 2. Pharma name2
        N202 0…1 1/60 Additional name 2. Pharma name2
      N3 0…2 - N3: Address: Child of customer party N1 name segment. -
        N301 1…1 1/55 Required. Street address 1. 555 Neelan Road
        N302 0…1 1/55 Street address 2. Suite 123
      N4 0…1 - N4: Geographic Location. Child of customer party N1 name segment. -
        N401 0…1 2/30 City name. Sacramento
        N402 0…1 2/2 State or province code. Code (Standard state/province) as defined by appropriate government agency. CA
        N403 0…1 3/15 Postal code. Code defining international postal zone code excluding punctuation and blanks. 95833
        N404 0…1 2/3 Country code. US
        N405 0…1 1/2 Type of location. CA
        N406 0…1 1/30 Specific location. 95833
        N407 0…1 1/3 Country subdivision. US
      PER 0…3 - PER segment explains about contact information for party business or location. -
        PER01 1…1 2/2

Required. Contact type.

Valid values:

  • IC - Information contact

  • FC - Forwarder contact

  • RP - Responsible contact

IC
        PER02 0…1 1/60 Contact name. Grame Smith
        PER03 0…1 2/2 Communication qualifier. TE
        PER04 0…1 1/2048 Contact phone number. '897654
        PER05 0…1 2/2 Communication qualifier. EM
        PER06 0…1 1/2048 Contact email address. gsmith@gmail.com
      REF(1) 0…100 - Reference segment for mapping to the transaction reference identifiers. -
        REF01 1…1 2/3

Required. Reference identification qualifier for the contract class.

ClosedValid values:
  • 10 - Consolidated Shipment Number
  • 14 - Master account

  • 1X - Credit debit adjustment identifier type

  • 2I - Tracking number

  • 72 - Schedule reference identifier

  • 92 - Document change Tracking number

  • A3 - Assignment

  • AG - Agent's sipment identifier

  • AM - Chargeback adjustment memo

  • BAF - Receipt number

  • BC - Customer contract number

  • BL - Government Bill of Lading

  • BM - Bill of lading

  • BT - Batch

  • CB - Combined Shipment

  • CD - Credit advice

  • CG - Conginee order number

  • CK - Check number

  • CM - Credit memo

  • CN - Carrier reference

  • CO - Customer order number, Identifies the number assigned by the customer to their order.

  • CR - Customer reference identifier

  • CT - Contract number

  • D1 - US Drug Enforcement Agency (DEA) order number

  • DD - Document number

  • DEA - DEA certificate identifier

  • DH - DEA identifier number

  • DI - Distributor invoice number

  • DL - Debit memo

  • DO - Delivery

  • EM - Electronic payment

  • GK - Third party reference identifier

  • IB - Customs regulatory document identifier for shipments transiting under bond

  • IK - Invoice party reference identifier

  • IN - Consignee's Invoice Number

  • IV - Seller's invoice

  • K9 - Customer inquiry number

  • MA - Ship notice or manifest number for shipment

  • MB - Master bill of lading

  • OI - Original invoice

  • OQ - Order number

  • P2 - Previous DEA identifier number

  • PK - Packing list number

  • PO - Purchase order number

  • PP - Purchase order revision number

  • PR - Price quote number

  • PT - Purchase Option Agreement

  • Q1 - Supplier quotation number

  • QD - DEA replacement identifier number

  • QP - Original purchase order number

  • RE - Release document number

  • RZ - Return authorization transaction identifier type

  • SI - Shipment number

  • SN - Seal number

  • SO - Shipper's Order (Invoice Number)

  • TB - Trucker's Bill of Lading

  • TN - Transaction reference number

  • VAT - VAT Number

  • VC - Supplier contract number

  • VN - Supplier order number

  • VR - Vendor identifier number

  • WH - Master Reference (Link) Number

  • WO - Work order (production order) number

CT
        REF02 0…1 1/80 Reference identifier value. 123456
        REF03 0…1 1/80 Description defined by qualifier code in REF02. sub-340B
      REF(2) 0…30 - Reference segment for mapping to the transaction references. -
        REF01 1…1 2/3

Required. Reference identification qualifier for the contract class.

ClosedValid values
  • 11 - Account Number

  • 14 - Master account number

  • 19 - Division identifier

  • 33 - Lender Case Number

  • 87 - Functional category

  • 1J - Facility ID Number

  • 1W - Group purchasing organization member identifier

  • 2I - Tracking Number

  • 2U - Payer Identification number for 340B programs

  • 3Y - Receiver Assigned Drop Zone

  • 4F - Carrier-assigned Shipper Number

  • 4N - Special Payment Reference Number

  • 6A - Consignee reference

  • 6L - Agent contract number

  • 6O - Cross Reference number

  • 7W - Interchange Train Identification

  • 8V - A credit reference number is a credit memo issued on the return of an original invoice number

  • 8X - Transaction Category

  • 9F - Referral Number

  • 9V - Payment Category

  • 9X - Account type/category

  • AAL - Booking agent reference

  • AAO - Carrier Assigned Code

  • ABS - Vessel Name

  • ACC - Status

  • ACD - Class Code

  • ACT - Accounting Code

  • ADI - Processor Identification Number

  • ADT - Full Denial Reason Identifier

  • AEM - Distribution center identifier

  • AF - Airlines Flight Identification Number

  • AHC - Air Handling Code

  • AO - Appointment Number

  • AW - Air way bill Number

  • BN - Booking number

  • BP - Adjustment control number

  • BS - Split booking reference number

  • C8 - Corrected contract number

  • CC - Collect Loads or Contract Co-op Number

  • CE - Class of contract code

  • CQ - Customs house broker license number

  • CR - Customer reference Number

  • CT - Contract number

  • DH - US Drug Enforcement agency identifier

  • DI - Distributor Invoice Number

  • DJ - Delivery ticket number as reference from shippers / carrier / consignees system

  • DNS - DUNS number with four character suffix

  • DP - Department identifier

  • DQ - Delivery Quote Number

  • E7 - Service Bulletin Number

  • ED - Customs export declaration reference Number

  • EP - Export License Number

  • EQ - Equipment number

  • EVI - Event Identification

  • FI - File Identifier

  • FN - Freight forwarder reference identifier

  • GT - Goods and service tax registration number

  • HI - US Health Industry Number

  • HR - Horsepower

  • HS - Harmonized code system (Canada)

  • IA - Internal vendor Number

  • IT - Internal customer number

  • IX - Item number

  • JH - Other tag number

  • KK - Proof Of Delivery

  • KL - Contract reference number

  • L1 - Letters or notes

  • LI - Line item number

  • LO - Load planning reference number

  • LT - Lot or batch number

  • LU - GS1-US Global Location Number (GLN)

  • MH - Manufacturing order number

  • MR - Merchandise type code

  • MTI - Master Tracking Number

  • NB - Letter of credit Number

  • OC - Ocean container number

  • OD - Original Return Request Reference Number

  • ON - Buyer assigned order identifier number

  • OT - Sales Allowance Number

  • P1 - Previous contract number

  • P2 - Previous DEA identifier

  • P3 - Previous HIN identifier

  • P7 - Product line number

  • P8 - Pickup reference number

  • PD - Promotion deal number

  • PE - Plant number

  • PHC - Process Handling Code

  • PRT - Product Type

  • Q8 - Company/place registration number

  • QN - Stop Sequence Number

  • QY - Express Service Code

  • RA - Repetitive Shipment Number

  • RF - Export reference number (not a licence number)

  • RU - Route Number

  • RX - Resubmit Number

  • RY - Rebate reference number

  • RZ - Returned goods authorization Number

  • RZ - Return goods authorization

  • SB - Sales Region Number

  • SCA - Standard Carrier Alpha Code (SCAC)

  • SE - Serial Number

  • SI - Shipper's Identifying Number for Shipment

  • ST - store number

  • SZ - Specification Revision

  • TD - Reason for change recorded for order

  • TG - Transportation control number

  • TS - Tariff reference number

  • VA - Vessel agent number

  • VN - Vendor order number referencing customer purchase order, ie, vendor sales order

  • VR - Internal vendor identifier

  • VT - Motor vehicle identification number

  • VX- VAT Registration identifier

  • X8 - Secondary class identifier

  • XX2 - Service Area Code

  • ZH - Carrier assigned reference / booking number

  • ZZ - Mutually defined transaction identifier

  • ZZ - Customer or mutually defined transaction identifier (DEPRECATED)

DNS
        REF02 0…1 1/80 Reference identifier value: 123456
        REF03 0…1 1/80 Description defined by qualifier code in REF02. -
      DTM 0...* - Dates, Effective date of organization entity data changes. -
        DTM01 1…1 3/3

Required. Date type related to shipment events at port, in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

ClosedValid values:
  • 002 - Delivery requested by date

  • 003 - Invoice date

  • 004 - Purchase order date

  • 007 - Effective date

  • 008 - Purchase order received date

  • 009 - Processing date

  • 010 - Shipment requested by date

  • 011 - Date shipped

  • 015 - Promotion start date

  • 016 - Promotion end date

  • 017 - Estimated delivery date

  • 018 - Product availability date

  • 020 - Check date

  • 023 - Promotion order start date

  • 024 - Promotion order end date

  • 025 - Promotion ship start date

  • 026 - Promotion ship end date

  • 035 - Date of delivery document, ASN

  • 036 - Expiration date

  • 037 - Not before shipment date

  • 038 - Not later shipment date

  • 040 - Status (After and Including)

  • 041 - Status (Prior and Including)

  • 050 - Date goods receipt posted (received into available inventory)

  • 058 - Customs Clearance date

  • 061 - Cancel by date

  • 067 - Current scheduled delivery date

  • 068 - Scheduled shipment date

  • 069 - Date of promised delivery

  • 070 - Delivery schedule date

  • 074 - Requested delivery date

  • 079 - Promised for shipment date

  • 090 - Report start date

  • 091 - Report end date

  • 092 - Contract effective date

  • 093 - Contract expiration date

  • 094 - Manufacturing date

  • 097 - Transactional date creation

  • 102 - Date goods issue posted

  • 133 - Account receivable date

  • 139 - Estimated

  • 140 - Actual date

  • 146 - Closing date

  • 161 - Loaded on vessel date

  • 166 - Message date

  • 168 - Release date

  • 184 - Inventory Update date

  • 188 - Credit advice date

  • 189 - Debit advise date

  • 196 - Date Start

  • 197 - End date

  • 208 - Lot expiration date

  • 311 - Latest receiving / cutoff date

  • 324 - Returned date

  • 369 - Estimated Departure Date

  • 370 - Actual Departure date

  • 371 - Estimated Arrival date

  • 372 - Actual arrival date

  • 472 - Date services rendered

  • 510 - Date packed

  • 512 - Warranty date

  • 514 - Transfer date

  • 649 - Document due date

  • 813 - Customs entry date

  • 814 - Payment due date

  • 922 - Date of original receipt

  • 938 - Order date

  • 964 - Billing date

  • 999 - Document date

  • AAG - Due date

  • VLU - Validity date

007
        DTM02 0…1 8/8 Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. 20241215
        DTM03 0…1 4/8 Time expressed in 24-hour clock time as follows. -
        DTM04 0…1 2/2 Time zone for referenced dates. ES
        DTM05 0…1 2/3

Describes the date format, time format, or date and time period format type.

ClosedValid values:
  • D6 - YYMMDD

  • D8 - CCYYMMDD

  • DD - DAYOFMONTH

  • DT - CCYYMMDDHHMM

  • MD - MMDD

  • T - MMDDYY

  • TM - HHMM

  • TQ - MMYY

  • TS - HHMMSS

  • TT - MMDDYY

  • YM - YYMM

DT
        DTM06 0…1 1/35 Describes the date format, time format, or date and time period. -
      ASI 0…1 - Indicates type of action to be taken or taken on the organization data -
        ASI01 1...1 '1/2

Required. Identifies the business action to be performed or that has been performed on an entity.

Valid values:

  • 1 - Adding

  • 2 - Update the record in master data.

  • 3 - Deleting the record

1
        ASI02 1...1 '3/3

Required. Specifies the type or scope of maintenance applied when performing the action, such as full replacement or selective update of entity data.

Valid values:

  • 001 - Existing item record is being updated

  • 002 - This item should no longer exist / be used

  • 003 - This is a brand-new item — create it

001
        ASI03 0...1 '3/3

Indicates the reason or justification for the action or status change of the entity. Note: No sample values were found in the guidelines.

ClosedValid values
  • 029 –Transfer of ownership is pending.
  • 049 – The merchandise was damaged or destroyed.
  • 052 – Import container delay
  • A01 – An unsuccessful attempt has been made to deliver the shipment
  • A03 – The address for the shipment is incorrect.
  • A04 – Indirect Delivery
  • A05 – The transportation carrier cannot find the customer location
  • A06 – The address for the shipment is incorrect or an additional address is required before the delivery can be completed.
  • A07 – Shipment refused by consignee or delivery party.
  • A09 – Goods damaged delivery has been completed
  • A10 – Goods damaged delivery has not been completed
  • A11 – The shipment could not be delivered because the business was closed.
  • A12 – Delay caused by carrier sorting the shipment incorrectly.
  • A13 – Other undefined reason
  • A14 – Returned to shipper
  • A15 – Business on strike. The action was frustrated by an industrial dispute.
  • A17 – Delay in delivery due to a customer or consignee's request.
  • A18 – Missort
  • A19 – Restricted articles are incompatible
  • A20 – Restricted articles are unacceptable
  • A24 – Delay in the shipment because of an accident.
  • A26 – An unspecified delay caused by consignee
  • A27 – The driver returned the shipment to the terminal
  • A29 – Hold changed to delivery package
  • A30 – A mechanical breakdown in the means of transport or equipment that were moving the goods.
  • A31 – Arrived in station after courier dispatch
  • A33 – Delivery delay caused by a non-specified carrier related reason.
  • A34 – Package shipped from overgoods
  • A36 – Holding in overgoods
  • A37 – Damaged rewrapped In hub
  • A39 – The customer previous to this stop caused a delay
  • A40 – Unspecified delay caused by shipper.
  • A42 – Delivery party facilities closed for holiday.
  • A43 – Shipment is delayed by severe weather or natural disasters.
  • A45 – Delivery not completed
  • A46 – Recipient Unavailable -- Delivery Delayed. No information available concerning the responsible at the delivery address.
  • A49 – Out of Delivery Area (ODA) cartage agent
  • A50 – Improper international paperwork
  • A55 – The shipment is on hold or has not been refused because customs and/or documentation issues.
  • A59 – Further instructions are required. Hold at location.
  • A65 – Customs release
  • A95 – Past cutoff time. Delivery of the goods/consignments/equipment has been scheduled past or later than the cut-off time.
  • A96 – Insufficient pickup time
  • B01 – Anticipated delay caused by contractor
  • B08 – Shipment is on hold pending contract unloading facility or equipment
  • B14 – Shipment is being held because of missing documents. Complete and correct documentation is required.
  • B15 – Shipment is being held pending clearance at a border point.
  • D01 – The shipment has been delayed for delivery because of a carrier dispatch error.
  • D50 – Further action on the delivery is delayed or postponed.
  • P02 – Relevant authorities have ordered the goods/consisgnments/equipment be held for inspection.
  • T07 – Insufficient delivery time at the delivery location prevented the carrier from completing delivery of the goods.
  • THT – A consignment or goods have been stolen.
  • W15 – Wrong equipment
-
SE 1…1 - Required. ST … SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected. -
  SE01 1…1 1/10 Required. Total count of segments in ST … SE transaction set including ST and SE segments. 10
  SE02 1…1 4/9 Required. Transaction set control number. 0001
GE 1…1 - Required. GS … GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected. -
  GE01 1…1 1/6 Required. Number of transaction sets in functional group. 5
  GE02 1…1 1/9 Required. Functional group control number. 619827
IEA 1…1 - Required. ISA … IEA interchange control trailer envelope. Only one interchange expected per transmission. -
  IEA01 1…1 1/5 Required. Number of functional groups in interchange. 1
  IEA02 1…1 9/9 Required. Interchange control number. 0000000000619827
ClosedExample
{
  "id": "d37a2068-d764-4144-9edd-d1e287b44684",
  "schemaId": "multienterprise-process-connect:canonicalOrganizationalRelationship",
  "schemaVersion": 1,
  "objectType": "canonicalOrganizationalRelationship",
  "data": {
    "controlFileHeader": {
      "fileSenderNumber": "COMPANYID:PAR",
      "fileReceiverNumber": "DEA:RV0464646",
      "linkIdentifier": "MPC.COMPANYID:PAR.DEA:RV0464646",
      "fileDateTime": "2019-01-25T09:12:00.000Z",
      "fileControlNumber": "828691477",
      "x12ControlFileHeader": {
        "x12InterchangeControlEnvelope": {
          "authorizationInformationType": "03",
          "authorizationInformationValue": "authorinfo",
          "securityInformationType": "00",
          "securityInformationValue": "securityin",
          "interchangeControlVersion": "00401",
          "interchangeControlIdentifier": "828691477",
          "usageIndicator": "P",
          "componentSeparator": ">",
          "repetitionSeparator": "U",
          "fileSenderType": {
            "ediEnvelopePartyType": "COMPANYID",
            "ediInterchangePartyValue": "PAR"
          },
          "fileReceiverType": {
            "ediEnvelopePartyType": "DEA",
            "ediInterchangePartyValue": "RV0464646"
          },
          "isAcknowledgmentRequired": false
        },
        "x12TransactionSetEnvelope": {
          "transactionSetControlNumber": "4931"
        },
        "x12FunctionalGroupControlEnvelope": {
          "groupSenderNumber": "PAR",
          "groupReceiverNumber": "RV0464646",
          "groupDate": "2019-01-25",
          "groupTime": "09:12:23.000Z",
          "groupControlNumber": "828691477",
          "x12AgencyCode": "X",
          "ediMessageVersionCode": "004010"
        },
        "x12TrailerSegments": [
          {
            "trailerSegmentType": "TRANSACTION",
            "trailerSegmentCount": 164,
            "trailerSegmentIdentifier": "2420001"
          },
          {
            "trailerSegmentType": "GROUP",
            "trailerSegmentCount": 1,
            "trailerSegmentIdentifier": "242"
          },
          {
            "trailerSegmentType": "INTERCHANGE",
            "trailerSegmentCount": 1,
            "trailerSegmentIdentifier": "000000242"
          }
        ]
      },
      "b2bTransactionTypeName": "MPC_ORGANIZATIONAL_RELATIONSHIP"
    },
    "canonicalOrganizationalRelationshipHeader": {
      "hierarchyStructureType": "SUPERGROUPSUBGROUPMEMBER",
      "processingFunctionTypeCode": "ORIGINAL",
      "mpcDates": [
        {
          "dateType": "RELEASE",
          "dateValue": "2025-03-10T11:22:33.450Z",
          "timeZone": "ES",
          "dateTimePeriodFormat": "CCYYMMDDHHMM"
        },
        {
          "dateType": "CREDITADVICE",
          "dateValue": "2025-03-11T22:33:44.000Z",
          "timeZone": "ES",
          "dateTimePeriodFormat": "CCYYMMDDHHMM"
        }
      ],
      "transactionReferenceIdentifierList": [
        {
          "b2bTransactionIdentifierType": "ORGANIZATIONALRELATIONSHIP",
          "b2bTransactionIdentifierValue": "1111",
          "transactionDate": "2015-04-24T22:33:44.000Z"
        },
        {
          "b2bTransactionIdentifierType": "TRACKINGNUMBER",
          "b2bTransactionIdentifierValue": "06416-2I5"
        },
        {
          "b2bTransactionIdentifierType": "MASTERBOL",
          "b2bTransactionIdentifierValue": "16416-MB"
        }
      ],
      "transactionReferenceInformation": [
        {
          "transactionReferenceType": "PAYERIDENTIFIER",
          "transactionReferenceIdentifier": "06416-2U5",
          "description": "desc2U"
        }
      ],
      "partnerBusinessInformation": [
        {
          "businessPartyInformation": {
            "partnerEntityType": "SENDER",
            "businessName": "Belk, Inc.",
            "mpcCompanyLocationIdentifierList": [
              {
                "companyIdentifierType": "DUNS",
                "companyIdentifierValue": "9999"
              }
            ],
            "additionalBusinessName": "N201",
            "address": {
              "address1": "Address1",
              "address2": "Address2",
              "city": "MONROE",
              "state": "NC",
              "postalCode": "28111",
              "country": "JP"
            },
            "mpcAdditionalAddressInformation": {
              "address3": "N202",
              "locationType": "11",
              "locationIdentifier": "N406",
              "countrySubDivisionCode": "407"
            },
            "companyLocationContactInformation": {
              "contactType": "INFORMATION",
              "contactName": "Contact",
              "contactEmail": "@email.com",
              "contactPhone": "9999999"
            }
          },
          "transactionReferenceIdentifierList": [
            {
              "b2bTransactionIdentifierType": "CONTRACT",
              "b2bTransactionIdentifierValue": "Contract Name"
            },
            {
              "b2bTransactionIdentifierType": "DOCUMENT",
              "b2bTransactionIdentifierValue": "Doc Name"
            }
          ],
          "transactionReferenceInformation": [
            {
              "transactionReferenceType": "INTERNALVENDORNUMBER",
              "transactionReferenceIdentifier": "DocIAName",
              "description": "descIA"
            }
          ]
        }
      ]
    },
    "canonicalOrganizationalRelationshipLineItemDetails": [
      {
        "hierarchicalLevel": [
          {
            "hierarchicalIdentifier": "1",
            "hierarchicalParentIdentifier": "1",
            "hierarchicalLevelCode": "COMPANY",
            "hierarchicalChildCode": "ONE"
          }
        ],
        "organizationalEntityBusinessInformation": [
          {
            "organizationalEntityInformation": {
              "partnerEntityType": "HEADOFFICE",
              "businessName": "Belk, Inc.",
              "mpcCompanyLocationIdentifierList": [
                {
                  "companyIdentifierType": "GLN",
                  "companyIdentifierValue": "3333331013655"
                }
              ],
              "additionalBusinessName": "N201L8",
              "address": {
                "address1": "Address1",
                "address2": "Adr2",
                "city": "City",
                "state": "CT",
                "postalCode": "99999",
                "country": "JP"
              },
              "mpcAdditionalAddressInformation": {
                "address3": "N202L8",
                "locationType": "11",
                "locationIdentifier": "N406",
                "countrySubDivisionCode": "407"
              },
              "companyLocationContactInformation": {
                "contactType": "FORWARDER",
                "contactName": "FC-Contact",
                "contactEmail": "email@email3.com",
                "contactPhone": "9-999-999-88888"
              }
            },
            "transactionReferenceIdentifierList": [
              {
                "b2bTransactionIdentifierType": "SEALNUMBER",
                "b2bTransactionIdentifierValue": "SN-11111"
              }
            ],
            "transactionReferenceInformation": [
              {
                "transactionReferenceType": "APPOINTMENTNUMBER",
                "transactionReferenceIdentifier": "AO-3333",
                "description": "REF03"
              }
            ],
            "mpcDates": [
              {
                "dateType": "EFFECTIVE",
                "dateValue": "2015-03-11T10:21:22.330Z",
                "timeZone": "ES",
                "dateTimePeriodFormat": "CCYYMMDDHHMM"
              }
            ],
            "entityAction": {
              "statusActionCode": "ADD",
              "maintenanceScopeType": "CHANGE",
              "transactionStatusReasonCode": "COURIERDISPATCHTOSTATION"
            }
          }
        ]
      }
    ]
  }
}
Review TraceLink's API: Terms of Use

Table of contents

Related Content
Related content
Forecast plan (IDoc)
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record.
View More
Related content
Forecast plan (X12)
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record.
View More
Related content
Forecast plan response (IDoc)
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record.
View More

Cookie Settings

When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies or similar tracking technologies. Please see below for an overview of the categories of cookies and similar technologies used on this site. You can allow or deny some of all of them, except Strictly Necessary Cookies which are required to provide the site to you. However, blocking some types of cookies may impact your experience of the site and services we are able to offer.

Please see our Cookie Policy for more details, including a list of the cookies we use. You can change your consent options at any time by following the “Cookie Settings” link in the Cookie Policy.
'Strictly Necessary' cookies let you move around the Site and use essential features like secure areas, shopping baskets and online billing. Without these cookies you would not be able to navigate between pages or use certain vital features of our Site, so we do not require your consent for their use. These cookies don't gather any information about you that could be used for marketing or remembering where you've been on the internet. For example, we use these Strictly Necessary cookies to identify you as being logged in to the Site. You can set your browser to block or alert you about these cookies, but if you do so, some parts of the Site will not work.
'Performance' cookies collect information about how you use the Site, such as which pages you visit, the time spent on the Site and if you experience any errors. We use performance cookies to provide aggregated statistics on how the Site is used and help us improve the Site including by measuring any errors that occur.
'Functional' cookies are used to provide services or to remember settings to improve your visit. We use 'Functionality' cookies to remember your settings and choices and show you when you're logged in to the Site.
‘Targeting' cookies are linked to services provided by third parties, such as 'Like' buttons and 'Share' buttons. The third party provides these services in return for recognizing that you have visited the Site. We also use 'Targeting' cookies to gather information that could be used to display content that we think may interest you.

Footer

  • Quick Links
    Get a Demo
    TraceLink Network Directory
    The Network
    OPUS Platform
    Technical Support
    Open Jobs
    API: Terms of Use
  • Products
    Multienterprise Information Network Tower
    U.S. DSCSA Compliance
    Targeted Recalls
    Process Orchestration for Empowered Teams
    Serialization
    Global Compliance
  • Resources
    Resource Center
    Events
    TraceLink University
    Partners
    Community
  • About TraceLink
    Our Story
    Newsroom
    Culture & Careers
    Leadership
    Our Values
    Corporate Social Responsibility
  • Hot Topics
    Transaction Integration
    Supply Chain Visibility
    DSCSA Compliance
    Process Orchestration
    Kazakhstan Compliance for Pharmaceuticals
    Kyrgyzstan Compliance for Pharmaceuticals
Follow Us on Social
Facebook
Linkedin
X
Legal & Trust.
© TraceLink Inc. 2009-2026 All Rights Reserved
Contact Us Today
Contact us today to begin your journey toward agentic supply chain orchestration — digitalize your end-to-end supply chain with intelligence, flexibility, and collaborative orchestration.
Contact Us
Stay Up-to-Date
Subscribe to receive industry insights and stay at the forefront of evolving trends.
Subscribe