Hapag Lloyd
/
Confirmation (Ocean)
  • Specification
  • EDI Inspector
Import guide into your account
Stedi maintains this guide based on public documentation from Hapag Lloyd. Contact Hapag Lloyd for official EDI specifications. To report any errors in this guide, please contact us.
Go to Stedi Network
Hapag Lloyd logo

X12 301 Confirmation (Ocean)

X12 Release 4010

This Draft Standard for Trial Use contains the format and establishes the data contents of the Confirmation (Ocean) Transaction Set (301) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to provide all the information necessary for an ocean carrier to confirm space, container, and equipment availability in response to the Reservation (Booking Request) (Ocean) Transaction Set (300); or to notify other parties such as terminal operators or other ocean carriers.

Delimiters
  • ~ Segment
  • * Element
  • > Component
EDI sample
    View the latest version of this implementation guide as an interactive webpage
    https://www.stedi.com/app/guides/view/hapag-lloyd/confirmation-ocean/01HDSFEC5CDSPX6V5P0BCDFT5G
    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
    010
    Transaction Set Header
    Max use 1
    Required
    B1
    020
    Beginning Segment for Booking or Pick-up/Delivery
    Max use 1
    Required
    Y3
    040
    Space Confirmation
    Max use 1
    Required
    Y4 Loop
    R4 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

    Code to identify 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

    Code to identify 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

    Qualifier to designate 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

    Qualifier to designate 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
    YYMMDD format

    Date of the interchange

    ISA-10
    I09
    Interchange Time
    Required
    HHMM format

    Time of the interchange

    ISA-11
    I10
    Interchange Control Standards Identifier
    Required

    Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer

    U
    U.S. EDI Community of ASC X12, TDCC, and UCS
    ISA-12
    I11
    Interchange Control Version Number
    Required

    This version number covers the interchange control segments

    00401
    Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997
    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 sent by the sender to request an interchange acknowledgment (TA1)

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

    Code to indicate 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

    Code identifying a group of application related transaction sets

    RO
    Ocean Booking Information (300, 301,303)
    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

    GS-04
    373
    Date
    Required
    CCYYMMDD format

    Date expressed as CCYYMMDD

    GS-05
    337
    Time
    Required
    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 used in conjunction with Data Element 480 to identify the issuer of the standard

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

    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

    004010
    Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997

    Heading

    ST
    010
    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

    Code uniquely identifying a Transaction Set

    • The transaction set identifier (ST01) used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set).
    301
    Confirmation (Ocean)
    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

    B1
    020
    Heading > B1

    Beginning Segment for Booking or Pick-up/Delivery

    RequiredMax use 1

    To transmit identifying numbers, dates, and other basic data relating to the transaction set

    Usage notes

    Example: B1HLCU14549844**N~

    Example
    B1-01
    140
    Standard Carrier Alpha Code
    Optional
    Identifier (ID)
    Min 2Max 4

    Standard Carrier Alpha Code

    • B101 is the Standard Carrier Alpha Code (SCAC) of the carrier sending the EDI transmission.
    Usage notes

    Standard Carrier Alpha Code (HLCU)

    B1-02
    145
    Shipment Identification Number
    Required
    String (AN)
    Min 1Max 30

    Identification number assigned to the shipment by the shipper that uniquely identifies the shipment from origin to ultimate destination and is not subject to modification; (Does not contain blanks or special characters)

    Usage notes

    HL-internal Shipment number

    B1-04
    558
    Reservation Action Code
    Optional

    Code identifying action on reservation or offering

    N
    New
    R
    Delete
    U
    Change
    Y3
    040
    Heading > Y3

    Space Confirmation

    RequiredMax use 1

    To specify confirmation information for space booking including numbers, dates, and load time

    Usage notes

    Example: Y340114000HLCU2013040220130430***1200SB~

    Example
    If Transportation Method/Type Code (Y3-09) is present, then Time (Y3-08) is required
    Y3-01
    13
    Booking Number
    Required
    String (AN)
    Min 1Max 17

    Number assigned by the carrier for space reservation

    • If space is available, all of the conditional data elements in segment Y3 are required. If the requested space is not available, Y301 is the booking number 'decline'.
    Usage notes

    HL-internal Shipment number

    Y3-02
    140
    Standard Carrier Alpha Code
    Optional
    Identifier (ID)
    Min 2Max 4

    Standard Carrier Alpha Code

    Usage notes

    Standard Carrier Alpha Code (HLCU)

    Y3-03
    373
    Date
    Optional
    CCYYMMDD format

    Date expressed as CCYYMMDD

    • Y303 is the date of departure of the vessel.
    Usage notes

    Planned Departure_Date at Depot

    Y3-04
    373
    Date
    Optional
    CCYYMMDD format

    Date expressed as CCYYMMDD

    • Y304 is the estimated arrival date at the port of discharge.
    Usage notes

    Expiration_Date of advice

    Y3-08
    337
    Time
    Optional
    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)

    • Y308 is the load time.
    Usage notes

    '1200' as dummy time when Y3:X0091 is populated

    Y3-09
    91
    Transportation Method/Type Code
    Optional

    Code specifying the method or type of transportation for the shipment

    SB
    Shipper Agent

    Shipper Agent / Merchant Haulage (Export)

    SC
    Shipper Agent (Truck)

    Shipper Agent / Carriers Haulage (Export)

    SD
    Shipper Association

    Shipper Association for IRT

    Y4 Loop
    OptionalMax >1
    Y4
    050
    Heading > Y4 Loop > Y4

    Container Release

    RequiredMax use 1

    To transmit information relative to containers available for release

    Usage notes

    Example: Y414217407*MTR0111*4532~

    Example
    Y4-01
    13
    Booking Number
    Optional
    String (AN)
    Min 1Max 17

    Number assigned by the carrier for space reservation

    • Y401 is used for the first booking number and Y402 for the last booking number in a range of numbers. If only one booking number is used, Y402 is omitted.
    Usage notes

    HL-internal Shipment number

    Y4-04
    154
    Standard Point Location Code
    Optional
    Identifier (ID)
    Min 6Max 9

    Code (Standard Point Location) defined by NMFTA point development group as the official code assigned to a city or point (for ratemaking purposes) within a city

    • Y404 is the Standard Point Location Code (SPLC) of the container pick-up location.
    Usage notes

    MTR011

    Y4-05
    95
    Number of Containers
    Optional
    Numeric (N0)
    Min 1Max 4

    Number of shipping containers

    Usage notes

    Amount of units per Equipment Type Group

    Y4-06
    24
    Equipment Type
    Optional
    Identifier (ID)
    Min 4Max 4

    Code identifying equipment type

    Usage notes

    ISO Equipment Type Group

    Y4-10
    56
    Type of Service Code
    Optional
    Identifier (ID)
    Min 2Max 2

    Code specifying extent of transportation service requested

    Y4 Loop end
    N1 Loop
    OptionalMax >1
    N1
    060
    Heading > N1 Loop > N1

    Name

    RequiredMax use 1

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

    Example
    N1-01
    98
    Entity Identifier Code
    Required
    Identifier (ID)
    Min 2Max 3

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

    N1-02
    93
    Name
    Optional
    String (AN)
    Min 1Max 60

    Free-form name

    N1 Loop end
    R4 Loop
    RequiredMax >1
    R4
    110
    Heading > R4 Loop > R4

    Port or Terminal

    RequiredMax use 1

    Contractual or operational port or point relevant to the movement of the cargo

    Usage notes

    Examples:
    R4RD5301HOUSTON, TXUSBARBOU017~
    R4LD5301HOUSTON, TXUSBARBOU003~

    Example
    If either Location Qualifier (R4-02) or Location Identifier (R4-03) is present, then the other is required
    R4-01
    115
    Port or Terminal Function Code
    Required

    Code defining function performed at the port or terminal with respect to a shipment

    L
    Port of Loading (Operational)

    (if available)

    P
    Dispatching Pool (Operational)

    (always)

    R
    Place of Receipt (Contractual)
    R4-02
    309
    Location Qualifier
    Optional

    Code identifying type of location

    D
    Census Schedule D
    K
    Census Schedule K
    R4-03
    310
    Location Identifier
    Optional
    String (AN)
    Min 1Max 30

    Code which identifies a specific location

    Usage notes

    Census Schedule D/K - Code

    R4-04
    114
    Port Name
    Optional
    String (AN)
    Min 2Max 24

    Free-form name for the place at which an offshore carrier originates or terminates (by transshipment or otherwise) its actual ocean carriage of property

    Usage notes

    Location name

    R4-05
    26
    Country Code
    Optional
    Identifier (ID)
    Min 2Max 3

    Code identifying the country

    Usage notes

    UN-Country code

    R4-06
    174
    Terminal Name
    Optional
    String (AN)
    Min 2Max 30

    Free-form field for terminal name

    Usage notes

    HL-internal Matchcode_Supplement

    R4 Loop end
    Heading end

    Detail

    LX Loop
    RequiredMax >1
    LX
    010
    Detail > LX Loop > LX

    Assigned Number

    RequiredMax use 1

    To reference a line number in a transaction set

    Usage notes

    Example: LX*1~

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

    Number assigned for differentiation within a transaction set

    N7
    020
    Detail > LX Loop > N7

    Equipment Details

    OptionalMax use 1

    To identify the equipment

    Usage notes

    Examples:
    N7HLXU3720639***2232~
    N7
    UNKN*0000001
    *
    *
    **
    2200~

    Example
    N7-01
    206
    Equipment Initial
    Optional
    String (AN)
    Min 1Max 4

    Prefix or alphabetic part of an equipment unit's identifying number

    • N701 is mandatory for rail transactions.
    Usage notes

    Prefix of unit (if known)
    'UNKN' if unit number not known

    N7-02
    207
    Equipment Number
    Required
    String (AN)
    Min 1Max 10

    Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred)

    Usage notes

    Number of unit (if known)
    '0000001' if unit number not known

    N7-22
    24
    Equipment Type
    Optional
    Identifier (ID)
    Min 4Max 4

    Code identifying equipment type

    Usage notes

    ISO Equipment Type Group

    W09
    021
    Detail > LX Loop > W09

    Equipment and Temperature

    OptionalMax use 1

    To relate equipment type and required temperatures

    Usage notes

    Example: W09CZ-6.6CE*****7010~

    Example
    If either Temperature (W09-02) or Unit or Basis for Measurement Code (W09-03) is present, then the other is required
    W09-01
    40
    Equipment Description Code
    Required

    Code identifying type of equipment used for shipment

    CN
    Container
    CZ
    Refrigerated Container

    (if temperature setting required)

    W09-02
    408
    Temperature
    Optional
    Decimal number (R)
    Min 1Max 4

    Temperature

    • W0902 is the minimum allowable temperature condition for shipment; (the qualifying temperature scale is specified in W0903).
    Usage notes

    Temperature setting

    W09-03
    355
    Unit or Basis for Measurement Code
    Optional

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

    CE
    Centigrade, Celsius
    W09-06
    3
    Free Form Message
    Optional
    String (AN)
    Min 1Max 60

    Free-form text

    • W0906 is used to describe the environment required within an ocean-type, refrigerated container when other than normal air is required.
    Usage notes

    Actual VENTILATION_OPEN value (if W09:X1122 = 'Z')

    W09-07
    1122
    Vent Setting Code
    Optional

    Code describing the setting on the air vents on ocean-type containers

    A
    Vent 25% Open
    B
    Vent 50% Open
    C
    Vent 75% Open
    D
    Vent 100% Open
    E
    Closed
    F
    Vent 10% Open
    Z
    Carrier to Set Based on Commodity Type

    (if not 0,10,25,50,75,100)

    W09-08
    488
    Percent
    Optional
    Numeric (N0)
    Min 1Max 3

    Percent expressed as 0 to 100

    • W0908 is the humidity percentage.
    Usage notes

    Humidity / Dehumidification in %

    W09-09
    380
    Quantity
    Optional
    Decimal number (R)
    Min 1Max 15

    Numeric value of quantity

    • W0909 is the number of air exchanges per hour.
    K1
    030
    Detail > LX Loop > K1

    Remarks

    OptionalMax use 10

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

    Usage notes

    Examples:
    K1CARBON DIOXYD IN PCT020~
    K1OXYGEN IN PCT010~
    K1NITROGEN IN PCT030~
    K1SPECIAL-ATMOSPHERECONTROLLED ATMOSPHERE~
    K1REMARKS1REMARKS2~
    K1REMARKS3REMARKS4~

    Example
    K1-01
    61
    Free-Form Message
    Required
    String (AN)
    Min 1Max 30

    Free-form information

    Usage notes

    CARBON DIOXYD IN PCT (X0061[01])
    OXYGEN IN PCT (X0061[01])
    NITROGEN IN PCT (X0061[01])
    corresponding value in % (X0061[02])
    SPECIAL-ATMOSPHERE (X0061[01])
    corresponding SPECIAL-ATMOSPHERE setting (X0061[02])
    NON OPERATING REEFER (X0061[01])
    (Unit)-Advice remarks (X0061[01])
    (Unit)-Advice remarks (X0061[02])

    K1-02
    61
    Free-Form Message
    Optional
    String (AN)
    Min 1Max 30

    Free-form information

    LX Loop end
    V1
    080
    Detail > V1

    Vessel Identification

    OptionalMax use 2

    To provide vessel details and voyage number

    Usage notes

    Example: V18406274ROME EXPRESS96E16HLCUL~

    Example
    At least one of Vessel Code (V1-01) or Vessel Name (V1-02) is required
    If Vessel Code Qualifier (V1-08) is present, then Vessel Code (V1-01) is required
    V1-01
    597
    Vessel Code
    Optional
    Identifier (ID)
    Min 1Max 8

    Code identifying vessel

    Usage notes

    Lloyds Register No.

    V1-02
    182
    Vessel Name
    Optional
    String (AN)
    Min 2Max 28

    Name of ship as documented in "Lloyd's Register of Ships"

    Usage notes

    Vessel name

    V1-03
    26
    Country Code
    Optional
    Identifier (ID)
    Min 2Max 3

    Code identifying the country

    • V103 is the code identifying the country in which the ship (vessel) is registered.
    V1-04
    55
    Flight/Voyage Number
    Optional
    String (AN)
    Min 2Max 10

    Identifying designator for the particular flight or voyage on which the cargo travels

    Usage notes

    Schedule Voyage No.

    V1-05
    140
    Standard Carrier Alpha Code
    Optional
    Identifier (ID)
    Min 2Max 4

    Standard Carrier Alpha Code

    • V105 identifies the ocean carrier.
    V1-08
    897
    Vessel Code Qualifier
    Optional

    Code specifying vessel code source

    L
    Lloyd's Register of Shipping
    Detail end

    Summary

    SE
    010
    Summary > SE

    Transaction Set Trailer

    RequiredMax use 1

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

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

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

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

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

    Summary end

    Functional Group Trailer

    RequiredMax use 1

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

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

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

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

    Assigned number originated and maintained by the sender

    Interchange Control Trailer

    RequiredMax use 1

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

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

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

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

    A control number assigned by the interchange sender

    EDI Samples

    Sample 1

    ISA*00* *00* *ZZ*SENDER *ZZ*RECEIVER *231027*2252*U*00401*000000001*0*T*>~
    GS*RO*SENDERGS*RECEIVERGS*20231027*225230*000000001*X*004010~
    ST*301*0001~
    B1*HLCU*40113992**N~
    Y3*40113992*HLCU*20130412*20130507****1200*SB~
    Y4*40113992***MTR011*1*2232****PP~
    Y4*40113992***MTR011*1*2200****PP~
    Y4*40113992***MTR011*1*4500****PP~
    R4*R*D*4601*NEW YORK, NY*US*TERMIN425~
    R4*L*D*4601*NEW YORK, NY*US*HOWLAN001~
    LX*1~
    N7*UNKN*0000001********************2232~
    W09*CZ*-6.6*CE*****70*10~
    K1*CARBON DIOXYD IN PCT*020~
    K1*OXYGEN IN PCT*010~
    K1*NITROGEN IN PCT*030~
    K1*SPECIAL-ATMOSPHERE*CONTROLLED ATMOSPHERE~
    K1*REMARKS1*REMARKS2~
    K1*REMARKS3*REMARKS4~
    LX*2~
    N7*GATU*8084352********************4500~
    LX*3~
    N7*UNKN*0000001********************2232~
    K1*SPECIAL-ATMOSPHERE*NONE~
    K1*NON OPERATING REEFER~
    V1*8406274*ROME EXPRESS*BM*96E16*HLCU***L~
    SE*25*0001~
    GE*1*000000001~
    IEA*1*000000001~

    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.