315 Status Message From INTTRA To Customer ASC X12 Version 4010 User Guide Version 1.7

Transcription

1 315 Status Message From INTTRA To Customer ASC X12 Version 4010 User Guide Version 1.7 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 1 of 20

2 315 Status Message From INTTRA To Customer ASC X12 Version 4010 I. Audience...3 II. General Conventions...3 A. Implementation...3 III. Message Flow...3 IV. 315 Message Specification...4 A. Changes from version 1.6 (June 2009) to version 1.7 (August 2009)...4 B. Changes from version 1.5 (April 2009) to version 1.6 (June 2009)...4 C. Changes from version 1.5 (December 2003) to version 1.5 (April 2009)...4 D. Changes from version 1.4 (April 2002) to version 1.5 (December 2003)...4 E. Status Message Enhancements Release (December 2003)...4 F. Message Hierarchy...4 G. INTTRA , Version V. Appendix A Sample Outbound Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 2 of 20

3 I. Audience This document is intended for business, technical and EDI personnel engaged in establishing an electronic connection with INTTRA for the purpose of receiving 315 status messages for container movements. The following sections provide information regarding General Conventions, Message Flow, and Message Specifications. Additional reference guides for purposes of establishing Internet based file exchange are also identified. II. General Conventions A. Implementation Version 1.7 of the INTTRA 315 Status Message represents the EDI transaction format by which INTTRA issues container status events to Customers. Container Status Events Messages are created and queued for delivery to Customer upon receipt of the status event message from Carrier, as noted in diagram below. All examples of Segment data are provided as guides only and not to be taken literally. Changes to Code values, Data elements or Segments must be discussed and approved by the Customer and INTTRA. M = Mandatory O = Optional X = X12 usage is dependent on the presence of another element D = Dependent (often on a user-defined business rule) III. Message Flow 1. INTTRA receives a container event messages from the carrier via EDI (ANSI 315 or IFTSTA standard) 2. INTTRA s proprietary Portal Application, INTTRAWorks, processes the transaction and based on shippers subscription settings, a corresponding message is sent to the shipper in the desired format (315, IFTSTA, Flat File or XML standard). It should be noted that all errors are handled by INTTRA s global EDI support and monitoring team, who utilize a comprehensive systems and message handling monitoring system. Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 3 of 20

4 IV. 315 Message Specification A. Changes from version 1.6 (June 2009) to version 1.7 (August 2009) 060-R4-115: Added qualifier 5 which denotes location type not specified by carrier. B. Changes from version 1.5 (April 2009) to version 1.6 (June 2009) 060-R4-309: Removed Census Schedule D and Census Schedule K from the location qualifier. 060-R4-310: Removed Schedule D/K from note. C. Changes from version 1.5 (December 2003) to version 1.5 (April 2009) 030-N9-128: Added Note: INTTRA will always provide either the Carrier Booking Number (BN) or the Bill of Lading Number (BM). Only one reference of each type will be sent, except Purchase Order and/or Bill of Lading. (April-2009) D. Changes from version 1.4 (April 2002) to version 1.5 (December 2003) 030-N9-128: Added qualifiers "SI", "FN", "6A", "FCN" and "PO". These reference types will be sent only if the customer has subscribed to receive them from the corresponding booking and the references are present on the current corresponding booking. E. Status Message Enhancements Release (December 2003) In response to customer and carrier requests, INTTRA has made several important enhancements to its EDI distribution mechanism for Status Events, (Available in Production December 21, 2003 with the release of INTTRA Works). Enhancement Summary: 1. More Cross Reference Values For Status Messages - Improved Matching with Customer Business Transactions: Allows customer to include Booking references in Status Messages received from INTTRA via EDI. Prior to this enhancement, the only cross reference values provided with EDI Status Messages were the carrier s Booking Number and one or more Bill of Lading numbers. With this enhancement, customers may elect to have INTTRA include one or more of the following additional cross-references when they are available from the related Booking. Shipper's Reference Forwarder's Reference Consignee's Reference Contract Party Reference Purchase Order Number (s) 2. INTTRA / Non-INTTRA Selectivity - Better Control of Status Message Flow: Gives customers the option to restrict the Status Message flow to only those Status Messages associated with Bookings placed through INTTRA. F. Message Hierarchy Page Pos. Seg. Req. Loop Notes and No. No. ID Name Des. Max.Use Repeat Comments ISA Interchange Control Header O GS Functional Group Header O ST Transaction Set Header M B4 Beginning Segment for Inquiry or Reply M N9 Reference Identification O Q2 Status Details (Ocean) O 1 Not Used 050 SG Shipment Status O 15 LOOP ID - R4 20 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 4 of 20

5 R4 Port or Terminal M DTM Date/Time Reference O 15 Not Used 080 V9 Event Detail O SE Transaction Set Trailer M GE Functional Group Trailer O IEA Interchange Control Trailer O 1 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 5 of 20

6 G. INTTRA , Version 1.7 Segment: ISA Interchange Control Header Position: 005 Loop: Usage: Optional Max Use: 1 Purpose: To start and identify an interchange of zero or more functional groups and interchangerelated control segments Syntax Notes: Semantic Notes: Comments: Notes: ISA*00* *00* *ZZ*INTTRA *ZZ*CUSTOMER ID *011019*0700*U*00401* *0*P*^ ISA01 I01 Authorization Information Qualifier M ID 2/2 Code to identify the type of information in the Authorization Information 00 No Authorization Information Present (No Meaningful Information in I02) ISA02 I02 Authorization Information M AN 10/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) ISA03 I03 Security Information Qualifier M ID 2/2 Code to identify the type of information in the Security Information 00 No Security Information Present (No Meaningful Information in I04) ISA04 I04 Security Information M AN 10/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) ISA05 I05 Interchange ID Qualifier M ID 2/2 Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified ZZ Mutually Defined ISA06 I06 Interchange Sender ID M AN 15/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 'INTTRA' ISA07 I05 Interchange ID Qualifier M ID 2/2 Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified ISA08 I07 Interchange Receiver ID M AN 15/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 Trading Partner ID ISA09 I08 Interchange Date M DT 6/6 Date of the interchange Date expressed as YYMMDD format ISA10 I09 Interchange Time M TM 4/4 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 6 of 20

7 Time of the interchange Time expressed as HHMM format ISA11 I10 Interchange Control Standards Identifier M ID 1/1 Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer Refer to Data Element Dictionary for acceptable code values. ISA12 I11 Interchange Control Version Number M ID 5/5 This version number covers the interchange control segments Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997 ISA13 I12 Interchange Control Number M N0 9/9 A control number assigned by the interchange sender ISA14 I13 Acknowledgment Requested M ID 1/1 Code sent by the sender to request an interchange acknowledgment (TA1) 0 No Acknowledgment Requested ISA15 I14 Usage Indicator M ID 1/1 Code to indicate whether data enclosed by this interchange envelope is test, production or information P Production Data T Test Data ISA16 I15 Component Element Separator M AN 1/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 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 7 of 20

8 Segment: GS Functional Group Header Position: 007 Loop: Usage: Optional Max Use: 1 Purpose: To indicate the beginning of a functional group and to provide control information Syntax Notes: Semantic Notes: 1 GS04 is the group date. 2 GS05 is the group time. 3 The data interchange control number GS06 in this header must be identical to the same data element in the associated functional group trailer, GE02. Comments: 1 A functional group of related transaction sets, within the scope of X12 standards, consists of a collection of similar transaction sets enclosed by a functional group header and a functional group trailer. Notes: GS*QO*INTTRA*CUSTOMER ID* *0700*1000*X* GS Functional Identifier Code M ID 2/2 Code identifying a group of application related transaction sets QO Ocean Shipment Status Information (313, 315) GS Application Sender's Code M AN 2/15 Code identifying party sending transmission; codes agreed to by trading partners 'INTTRA' GS Application Receiver's Code M AN 2/15 Code identifying party receiving transmission; codes agreed to by trading partners Trading Partner ID GS Date M DT 8/8 Date expressed as CCYYMMDD GS Time M TM 4/8 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) GS06 28 Group Control Number M N0 1/9 Assigned number originated and maintained by the sender GS Responsible Agency Code M ID 1/2 Code used in conjunction with Data Element 480 to identify the issuer of the standard X Accredited Standards Committee X12 GS Version / Release / Industry Identifier Code M AN 1/12 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 Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997 Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 8 of 20

9 Segment: ST Transaction Set Header Position: 010 Loop: Usage: Mandatory Max Use: 1 Purpose: To indicate the start of a transaction set and to assign a control number Syntax Notes: Semantic Notes: 1 The transaction set identifier (ST01) is used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set). Comments: Notes: ST*315*0001 ST Transaction Set Identifier Code M ID 3/3 Code uniquely identifying a Transaction Set 315 Status Details (Ocean) ST Transaction Set Control Number M AN 4/9 Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 9 of 20

10 Segment: B4 Beginning Segment for Inquiry or Reply Position: 020 Loop: Usage: Mandatory Max Use: 1 Purpose: To transmit identifying numbers, dates, and other basic data relating to the transaction set Syntax Notes: 1 If either B407 or B408 is present, then the other is required. 2 If either B411 or B412 is present, then the other is required. Semantic Notes: 1 B404 is the date of last reported status of cargo. Comments: Notes: Sample 1: B4***AE* *2235**CXXX* *L*L5RT*USNYC*UN~ Sample 2 : B4***AE* *2235**CXXX* *E*L5RT*Danville *CI~ The location values transmitted are listed as provided by Carrier. B Shipment Status Code O ID 1/2 Code indicating the status of a shipment INTTRA will always supply Statuses as defined by the ISA standard code set. B Date O DT 8/8 Date expressed as CCYYMMDD Date of the event, (INTTRA will always supply this date) B Status Time O TM 4/4 Time (HHMM) of last reported status of cargo B Equipment Initial X AN 1/4 Prefix or alphabetic part of an equipment unit's identifying number INTTRA will always supply the Container Prefix B Equipment Number X AN 1/10 Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred) INTTRA will always supply the Container Number (Value includes the Container check digit, if provided) B Equipment Status Code O ID 1/2 Code indicating status of equipment INTTRA will always supply one of the following values: E Empty L Load B Equipment Type O ID 4/4 Code identifying equipment type INTTRA will always supply the ISO code set B Location Identifier X AN 1/30 Code which identifies a specific location INTTRA will always supply the Event location - UNLOCODE, Schedule K & D, or City Name B Location Qualifier X ID 1/2 Code identifying type of location INTTRA will always supply one of the following values: CI City Full name of City (Place of Activity) D Census Schedule D Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 10 of 20

11 K UN Census Schedule K United Nations Location Code (UNLOCODE) Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 11 of 20

12 Segment: N9 Reference Identification Position: 030 Loop: Usage: Optional Max Use: 30 Purpose: To transmit identifying information as specified by the Reference Identification Qualifier Syntax Notes: 1 At least one of N902 or N903 is required. 2 If N906 is present, then N905 is required. 3 If either C04003 or C04004 is present, then the other is required. 4 If either C04005 or C04006 is present, then the other is required. Semantic Notes: 1 N906 reflects the time zone which the time reflects. 2 N907 contains data relating to the value cited in N902. Comments: Notes: N9*BN* ~ In addition to the references sent by Carrier in the status message, Inttra can configure the customer's subscription to optionally include or exclude the following references from corresponding booking (if present) in the precedence mentioned below: 1. Shipper's Reference 2. Forwarder's Reference 3. Consignee's Reference 4. Contract Party Reference 5. Purchase Order 6. Bill of Lading Reference Note: Inttra will always provide Carrier SCAC code as reference. INTTRA will always provide either the Carrier Booking Number (BN) or the Bill of Lading Number (BM). Only one reference of each type will be sent, except Purchase Order and/or Bill of Lading. N Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification INTTRA supplied values: 6A BM BN CA FCN FN PO Consignee Reference Number Bill of Lading Number Note: may repeat Note: Bill of Lading Number will always be provided if a Carrier Booking Number is not informed. Booking Number Carrier's Booking Number Note: Carrier Booking Number will always be provided if a Bill of Lading Number is not informed. Cost Allocation Reference Used for Carrier SCAC code (always provided) Assigned Contract Number Forwarder's/Agent's Reference Number Purchase Order Number Note: may repeat Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 12 of 20

13 SI Shipper's Identifying Number for Shipment (SID) A unique number (to the shipper) assigned by the shipper to identify the shipment ZZ Mutually Defined INTTRA's Booking Number N Reference Identification X AN 1/30 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 13 of 20

14 Segment: Q2 Status Details (Ocean) Position: 040 Loop: Usage: Optional Max Use: 1 Purpose: To transmit identifying information relative to identification of vessel, transportation dates, lading quantity, weight, and cube Syntax Notes: 1 If any of Q207 Q208 or Q216 is present, then all are required. 2 If Q210 is present, then Q211 is required. 3 If either Q214 or Q215 is present, then the other is required. Semantic Notes: 1 Q202 is the code identifying the country in which the ship (vessel) is registered. 2 Q203 is the required pier date. 3 Q204 is the date of departure of the vessel. 4 Q205 is the date the shipment was unloaded from the vessel. Comments: Notes: Q2* *DK*******43W***L*VESSEL NAME~ Q Vessel Code O ID 1/8 Code identifying vessel Lloyd's code or Carrier's Call Signal Q Country Code O ID 2/3 Code identifying the country Country of Vessel Registry Q Flight/Voyage Number O AN 2/10 Identifying designator for the particular flight or voyage on which the cargo travels Q Vessel Code Qualifier O ID 1/1 Code specifying vessel code source INTTRA will always supply one of the following values: C Ship's Radio Call Signal L Lloyd's Register of Shipping Q Vessel Name O AN 2/28 Name of ship as documented in "Lloyd's Register of Ships" Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 14 of 20

15 Segment: R4 Port or Terminal Position: 060 Loop: R4 Mandatory Usage: Mandatory Max Use: 1 Purpose: Contractual or operational port or point relevant to the movement of the cargo Syntax Notes: 1 If either R402 or R403 is present, then the other is required. Semantic Notes: Comments: 1 R4 is required for each port to be identified. Notes: R4*L*UN*USNYC*NEW YORK CITY~ At least one instance of the R4 loop is MANDATORY as defined by the ANSI X12 standard. The location values transmitted are listed as provided by Carrier. INTTRA will always provide the Port of Loading and Port of Discharge values. R Port or Terminal Function Code M ID 1/1 Code defining function performed at the port or terminal with respect to a shipment INTTRA will always supply at least one of the following values: 5 Activity Location (Operational) Place at which the activity being reported is occurring Location type not specified by carrier. D Port of Discharge (Operational) Port at which cargo is unloaded from vessel E Place of Delivery (Contractual) Place at which cargo leaves its care and custody of carrier L Port of Loading (Operational) Port at which cargo is loaded on vessel R Place of Receipt (Contractual) Place at which cargo enters the care and custody of carrier R Location Qualifier X ID 1/2 Code identifying type of location INTTRA will always supply at least one of the following values: CI City City name or Port Location UN United Nations Location Code (UNLOCODE) R Location Identifier X AN 1/30 Code which identifies a specific location UNLOCODE or blank if R402 = 'CI' R Port Name O AN 2/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 City Name or Port Location is used if R402 = 'CI' Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 15 of 20

16 Segment: DTM Date/Time Reference Position: 070 Loop: R4 Mandatory Usage: Optional Max Use: 15 Purpose: To specify pertinent dates and times Syntax Notes: 1 At least one of DTM02 DTM03 or DTM05 is required. 2 If DTM04 is present, then DTM03 is required. 3 If either DTM05 or DTM06 is present, then the other is required. Semantic Notes: Comments: Notes: DTM*139* *0800~ Represents the Date and Time of the Port Activity. DTM Date/Time Qualifier M ID 3/3 Code specifying type of date or time, or both date and time INTTRA will always supply one of the following values: 139 Estimated 140 Actual DTM Date X DT 8/8 Date expressed as CCYYMMDD DTM Time X TM 4/8 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) Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 16 of 20

17 Segment: SE Transaction Set Trailer Position: 090 Loop: Usage: Mandatory Max Use: 1 Purpose: Syntax Notes: Semantic Notes: To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments) Comments: 1 SE is the last segment of each transaction set. Notes: SE*11*0001~ SE01 96 Number of Included Segments M N0 1/10 Total number of segments included in a transaction set including ST and SE segments SE Transaction Set Control Number M AN 4/9 Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 17 of 20

18 Segment: GE Functional Group Trailer Position: 100 Loop: Usage: Optional Max Use: 1 Purpose: To indicate the end of a functional group and to provide control information Syntax Notes: Semantic Notes: 1 The data interchange control number GE02 in this trailer must be identical to the same data element in the associated functional group header, GS06. Comments: 1 The use of identical data interchange control numbers in the associated functional group header and trailer is designed to maximize functional group integrity. The control number is the same as that used in the corresponding header. Notes: GE*1*1000 GE01 97 Number of Transaction Sets Included M N0 1/6 Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element GE02 28 Group Control Number M N0 1/9 Assigned number originated and maintained by the sender Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 18 of 20

19 Segment: IEA Interchange Control Trailer Position: 110 Loop: Usage: Optional Max Use: 1 Purpose: Syntax Notes: Semantic Notes: Comments: Notes: To define the end of an interchange of zero or more functional groups and interchangerelated control segments IEA*1* IEA01 I16 Number of Included Functional Groups M N0 1/5 A count of the number of functional groups included in an interchange IEA02 I12 Interchange Control Number M N0 9/9 A control number assigned by the interchange sender Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 19 of 20

20 V. Appendix A Sample Outbound 315 ISA*00* *00* *ZZ*INTTRA *ZZ*CU1000 *090322*0737*U*00401* *0*P*> GS*QO*INTTRA*CU1000* *0737* *X* ST*315*0001 B4***OB* *1530**CA10*EQ11*L*42R0*USNYC*UN N9*CA*CA10 N9*BN*0321-OCBN N9*BM*BM0105 Q2*64120*US*******5050***C*QUEEN ELIZABETH R4*R*UN*USNYC DTM*139* * SE*9*0001 GE*1* IEA*1* Copyright 2009 INTTRA Inc. All rights reserved. Version 1.7 August 7, 2009 Page 20 of 20