51
DHL Confidential & Proprietary DHL Express Confidential and Proprietary DHL Shipment Status Interchange (SSI) Specification v13.02 Doc. Ref.: DHL SSI Implementation and User Guide v13.02 Version: 13.02 Status: Approved Created by: John Mihaiu EDI Specialist Effective Date: January 2, 2018

DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

  • Upload
    others

  • View
    44

  • Download
    2

Embed Size (px)

Citation preview

Page 1: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

DHL Confidential & Proprietary

DHL Express

Confidential and Proprietary

DHL Shipment Status Interchange (SSI) Specification v13.02

Doc. Ref.: DHL SSI Implementation and User Guide v13.02

Version: 13.02

Status: Approved

Created by:

John Mihaiu EDI Specialist

Effective Date:

January 2, 2018

Page 2: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

DHL Confidential & Proprietary

Confidentiality

The specifications, definitions and examples in this manual are to be used by the recipient for the sole purpose of programming to meet DHL Express requirements, and should not be altered or modified by the recipient.

This document contains confidential, proprietary information. No part of this document may be used, modified, reproduced, disseminated, or disclosed without the express written consent of DHL Express, Inc. DHL employees, third-party vendors (3PV’s), and others authorized to use this document shall only disclose this information internally to their coworkers, employees, or agents on a need-to-know basis and in keeping with DHL confidentiality requirements. The information in this document is subject to change without notice.

DHL EXPRESS SHALL NOT BE LIABLE FOR TECHNICAL OR EDITORIAL ERRORS OR OMISSIONS CONTAINED HEREIN NOR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OF THIS INFORMATION.

© 2012 DHL Express, Inc. All rights reserved.

Terms and Conditions

The requirements and specifications outlined in this manual are governed by DHL’s General Terms and Conditions, found on DHL’s website, www.DHL.com.

Page 3: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page i of 51 DHL Confidential & Proprietary

Contents

Chapter 1 ........................................................................................................ 5

Introduction .................................................................................................... 5

1.1 EDI Definition ......................................................................................................................... 5 1.2 Audience ................................................................................................................................ 5 1.3 Shipment Status Extraction Process ..................................................................................... 5

Chapter 2 ........................................................................................................ 7

EDI Guidelines ................................................................................................ 7

2.1 Requirements ........................................................................................................................ 7 2.2 SSI Setup Process ................................................................................................................ 7

Chapter 3 ........................................................................................................ 9

Shipment Status Configuration ...................................................................... 9

3.1 Electronic Shipment Status Format Summary ...................................................................... 9

Chapter 4 ...................................................................................................... 10

Data Element Matrix .................................................................................... 10

4.1 Data Element Matrix based on Format ................................................................................ 10

Chapter 5 ...................................................................................................... 12

Data Delivery Options .................................................................................. 12

5.1 Message Transport Options ................................................................................................ 12 5.2 File Notification .................................................................................................................... 13 5.3 Data Retention ..................................................................................................................... 13

Chapter 6 ...................................................................................................... 14

Configuration Options .................................................................................. 14

6.1 Shipment Status Event Codes ................................................................. 14

6.2 Progress Checkpoint Events Information ................................................ 14

6.3 Completion Checkpoint Events ............................................................... 14

6.4 Service Incident Events ........................................................................... 15

6.5 Custom Select Service Events ................................................................. 15

Chapter 7 ...................................................................................................... 16

Shipment Status Schedules ........................................................................... 16

7.1 Processing and Schedule Options ...................................................................................... 16

Page 4: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page ii of 51 DHL Confidential & Proprietary

Chapter 8 ...................................................................................................... 17

EDI Compliance Testing ................................................................................ 17

8.1 SSI Testing .......................................................................................................................... 17

Chapter 9 ...................................................................................................... 18

Resources ..................................................................................................... 18

9.1 Who to Contact .................................................................................................................... 18

Chapter 10 .................................................................................................... 19

SSI Format04 ................................................................................................ 19

10.1 Data Structure.................................................................................................................... 19 Batch Header Record ............................................................................................................ 19 Record Layout ....................................................................................................................... 19 Batch Trailer Record .............................................................................................................. 21

Chapter 11 .................................................................................................... 22

SSI Comma Delimited Format ....................................................................... 22

11.0 Data Structure.................................................................................................................... 22

Chapter 12 .................................................................................................... 24

SSI ANSI 214 Format .................................................................................... 24

12.0 Data Structure.................................................................................................................... 24 ISA: Interchange Control Header ............................................................................................. 24 GS: Functional Group Header .................................................................................................. 25 ST: Transaction Set Header ..................................................................................................... 25 B10: Beginning Segment .......................................................................................................... 25 L11: Reference Number ........................................................................................................... 26 N1: Name ................................................................................................................................... 26 N3: Address Information ........................................................................................................... 26 N4: Geographic Location .......................................................................................................... 27 G61: Contact ............................................................................................................................. 28 G62: Date/Time ........................................................................................................................ 28 MS3: Interline Information ........................................................................................................ 28 LX: Assigned Number ............................................................................................................... 29 AT7: Shipment Status Details ................................................................................................... 30 MS1: Shipment Location .......................................................................................................... 30 K1: Remarks ............................................................................................................................. 30 AT8: Shipment Weight, Packaging and Quantity ..................................................................... 31 CD3: Carton (Package) Detail ................................................................................................... 31 SE: Transaction Set Trailer ...................................................................................................... 31 GE: Functional Group Trailer .................................................................................................... 31 IEA: Interchange Control Trailer ............................................................................................... 32 12.1 ANSI X12 Setup Information ............................................................................................. 32

Chapter 13 .................................................................................................... 33

DHL SHIPTNR Format .................................................................................... 33

13.0 Data Structure.................................................................................................................... 33

Page 5: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page iii of 51 DHL Confidential & Proprietary

13.1 Customer Reference Record ............................................................................................. 33 13.2 Shipment Record ............................................................................................................... 33

Appendix A: Product Type ........................................................................... 37

Appendix B: Packaging Type ....................................................................... 38

Appendix C: Signature Sub Codes ............................................................... 39

Appendix D: Shipment Status Event Codes ................................................. 40

Appendix F: Shipment Exception Event Codes ............................................. 42

Glossary ........................................................................................................ 46

Terminology ............................................................................................................................... 46

Revision History ............................................................................................ 47

Page 6: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page iv of 51

DHL Confidential & Proprietary

This page was intentionally left blank

Page 7: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 5 of 51 DHL Confidential & Proprietary

Chapter 1 Introduction

1.1 EDI Definition Electronic Data Interchange (EDI) is the computer-to-computer exchange of electronic business data in an agreed upon format. DHL provides this shipment status service via EDI at no cost to our customers because we understand the benefits that this service affords them:

Improved business relationships because DHL electronic shipment status provides the flexibility that our customers need.

Reduced costs because electronic shipment status bypasses the manual and costly data entry process typically used to retrieve status details.

Increased productivity

Increased accuracy

Increased profits

1.2 Audience This document is intended to serve as a guide to assist trading partners in receiving electronic shipment status messages for US Outbound, US Inbound and international-to-international shipments in a standard X12 or a DHL proprietary flat file format. The primary audience of this document is intended to be the trading partner’s technical or EDI support staff.

1.3 Shipment Status Extraction Process As a package travels to its destination via DHL, it is tracked along the way with shipment status event updates being posted to DHL’s global tracking system. DHL’s Shipment Status Interchange (SSI) system, in turn, automatically reports new shipment status events for DHL Express international inbound, outbound and international-to-international customer shipments.

Shipment information is gathered and transmitted to DHL’s global tracking system quickly and accurately through the use of barcodes and barcode scanners. DHL drivers as well as DHL’s automated hubs have barcode scanners that record the location and status of shipments as they travel through the transportation and delivery cycle.

All relevant information about transportation and delivery of a package is available through the SSI system. For example, if delivery had been attempted but was not successful, or if the package had an invalid address, that information would be sent through the SSI system, as would the final delivery information. A list of all of the potential events is available in the later chapters of this document.

Page 8: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 6 of 51 DHL Confidential & Proprietary

Note: Customers with pick-up, delivery or other scan exemptions will not receive scan information on their packages for which the exemption(s) applies.

Shipment status files are created based on an extract schedule defined for each trading partner. An SSI processing schedule can vary from once a week to multiple times per day. Any new shipment status events recorded subsequent to a customer’s previous extract will be included in the next scheduled run for that customer. For example, if a customer is scheduled for a 10 AM extract and a 4 PM extract, the 4 PM extract will include any shipment status events recorded between 10 AM and 4 PM.

DHL’s SSI system will begin to send out shipment status events to a customer based on how the SSI processing options are set up for the customer’s Trading Partner ID (assigned by DHL).

Dispositions are based on local time zone where the event occurred.

Page 9: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 7 of 51 DHL Confidential & Proprietary

Chapter 2 EDI Guidelines

2.1 Requirements In addition to accepting DHL’s terms and conditions all customers must comply with the following requirements:

Customer Service Claims

The SSI program is approved for each customer based on the agreement that the information obtained from the SSI file will not be used to file service claims against DHL. The information will be provided to the customer to use for informational purposes and to allow customers to give up to date responses to their own customers when they inquire on the status of their shipments.

Programming Updates

Customers are responsible for making changes to support addenda or revisions within the time-frame defined by DHL. DHL will make best-effort attempts to provide 60 days notice.

Data Transport

DHL provides a variety of communications options. It is the customer’s responsibility to retrieve the files in a timely manner.

Failure to retrieve electronic shipment status files in a timely manner may result in a termination of EDI service.

2.2 SSI Setup Process The SSI setup process consists of the following steps:

1. Review the SSI user implementation guide and decide on format, configuration options and details of file delivery.

2. Contact DHL’s EDI Site Activations Analyst for consultation.

3. Complete SSI customer request packet that includes: trading partner information, account numbers, file format, file delivery method, delivery schedule and selected configuration items. Customer must provide ISA/GS receiver id and receiver qualifier if the DHL214 X12 file format is selected. Return the signed SSI agreement.

4. A Trading Partner ID is setup by DHL and SSI files containing live shipment data is provided to the customer for active shipments associated to the account(s)

Page 10: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 8 of 51 DHL Confidential & Proprietary

provided by the customer. Files will continue to be created from this point forward.

5. Customer completes configuration and programming to receive and process SSI files, in accordance to the DHL SSI specifications, in their backend systems.

6. Refer to the “Getting Help” section within this guide if you have questions during the implementation process.

Page 11: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 9 of 51 DHL Confidential & Proprietary

Chapter 3 Shipment Status Configuration

3.1 Electronic Shipment Status Format Summary Select the format that best suits your internal processing needs. DHL does not customize or modify existing formats. These files are not sorted, preformatted, or sub-totaled. While all of the record layouts show the “field name” (or header), actual data received will not contain field headers.

DHL Express provides electronic shipment status in the following formats.

Format 4– DHL’s proprietary format which is a multiple record flat file format with elements defined by field-width to a total of 160-bytes.

Comma Delimited Format – This is single record format with a comma separating each field. This format is easy to pull data into spreadsheet software.

SHIPTNR Format - SHIPTNR is a flat file format with elements defined by field-width to a total of 1000-bytes. Additional fields offer the customer greater detail on the status of their shipments without the looping format of the ANSI X12 looping structure. For domestic shipments, the International fields will contain blanks, zeroes, or other non-applicable data.

Format 214 – This ANSI X12 format is widely used, making it a good choice for customers using multiple carriers and that want to receive shipment status information from all in the same format. An EDI translator is required to process the X12-214 data files.

For more information about ASC X12 standards or to purchase an Implementation Guide, contact:

American National Standards Institute 1800 Diagonal Road, Suite 355

Alexandria, VA 22314 (703) 548-7005

http://www.x12.org/ http://www.disa.org/

Page 12: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 10 of 51 DHL Confidential & Proprietary

Chapter 4 Data Element Matrix

4.1 Data Element Matrix based on Format

Data Element FMT04 Comma ANSI X12 214

SHIPTNR

Actual Weight X X

Bill To Party X

Broker Notify Date X

Broker Pickup Date X

Consignee Address X X

Consignee City X X

Consignee Country X X

Consignee Name X X X

Consignee Number X X

Consignee Reference X

Consignee State X X X

Consignee Postal Code X X X

Customer/Account Number X X X

Customer Reference Number X X

Customs Clearance Date X

DHL Destination Station X X X

DHL Origin Station X X X

Dim/Reweigh X

Domestic/International Code X

Entity Identifier Code X

Event Date X X X X

Event Time X X X X

Expected Delivery Date X

Expected Delivery Time X

Mode X

Number Of Pieces X X X X

Package Type X X

Page 13: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 11 of 51 DHL Confidential & Proprietary

Data Element FMT04 Comma ANSI X12 214

SHIPTNR

Pickup Date X X X X

Pickup Time X X X X

Product Type X X X

Service Type / Indicator X X X X

Shipment Description X

Shipment Status Event Code X X X X

Shipment Exception Event Code X X X X

Shipment Status Event Description X

Shipment Status Event City, State, Country

X

Shipper Address 1 X X

Shipper Address 2 X X

Shipper Address 3 X

Shipper City X X

Shipper Country X X

Shipper Name X X

Shipper Number X X

Shipper Postal Code X X

Shipper Reference Number X X X X

Shipper State X

Signature / Comments (final shipment status event sub code or shipment exception event code)

X X X X

Tracking Number X X X X

Trading Partner ID X

Weight Unit of Measure X

Page 14: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 12 of 51 DHL Confidential & Proprietary

Chapter 5 Data Delivery Options

5.1 Message Transport Options DHL promotes communication methods and protocols that provide guaranteed delivery, enhanced security, and are resilient resulting in improved customer service and lower support cost. These protocols provide a level of security and reliability which allows DHL to effectively support your electronic business transactions. DHL recommends the use of secure protocols, such as Cyclone or secure FTP, to transfer sensitive data.

Communication Method

Guaranteed Delivery

Built in Resend Rules

Encryption Communication Charges

EDINT AS2 Y Y Y N

EDINT AS1 Y Y Y N

FTP Mailbox (Ecportal)

Y* Y* Y* N

* available upon request

DHL supports the following communication options to exchange shipment status files:

EDIINT AS2 – an HTTPS based transport specification using SMIME encryption. DHL’s preferred communication method as it is easy to implement and very robust. The IETF working group has a webpage and information can be found at http://www.ietf.org/html.charters/OLD/ediint-charter.html.

DHL supports connectivity to your existing B2B application that is AS2 compliant. DHL has established communication with many 3rd party software solutions including: Cyclone Interchange/Central, WebMethods, Tibco BCRN, Microsoft Biztalk, and Templar.

DHL can provide customers with a B2B application at no charge that is AS2 compliant. The typical implementation can be done in 1-3 business days and requires no firewall changes. Ask your DHL EDI administrator for additional details.

EDIINT AS1 – an SMTP based transport specification using SMIME encryption. This is good for small files which are not necessarily time sensitive. This method is relatively quick to setup and typically robust.

DHL supports connectivity to your existing B2B application that is AS1 compliant. DHL has established communication with many 3rd party software solutions including: Cyclone Interchange/Central, WebMethods, Tibco BCRN, Microsoft Biztalk, and Templar.

DHL can provide customers with a B2B application at no charge that is AS1 compliant. The typical implementation can be done in 1-3 business days and requires no firewall changes. Ask your DHL EDI administrator for additional details.

Page 15: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 13 of 51 DHL Confidential & Proprietary

FTP Mailbox – an ECPortal mailbox created and managed by DHL. The mailbox allows customers to systematically send or receive messages or retrieve the messages on the internet using a web browser.

5.2 File Notification DHL can provide an email notification when a new SSI file has been created. This notification contains the following details:

Application Cycle Number Batch Control Number Trading Partner ID Remote ID Format Description Total Number of Shipments Total Number of Dispositions Total Number of Account Numbers

5.3 Data Retention DHL will retain shipment status data for 30 days. During these 30 days after the original data was produced, the data file can be provided to the customer again upon request. After this time period the data is no longer available to be resent.

Page 16: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 14 of 51 DHL Confidential & Proprietary

Chapter 6 Configuration Options

6.1 Shipment Status Event Codes As a package goes through the delivery process, it is scanned multiple times. Each time it is scanned, a shipment status event is attributed to the shipment and posted to DHL’s global tracking system as part of the shipment history. The following are descriptions of the information available for the various shipment status event choices available.

6.2 Progress Checkpoint Events Information DHL pick up disposition can be requested by customers to be sent as the first shipment status of a waybill, independent of any other shipment status events that the customer may request. Any or all shipment status events can be requested with or without pickup information.

6.3 Completion Checkpoint Events The following seven shipment status events are considered FINALS. Most customers are interested in FINALS only due to the decreased volume of information they will receive for each shipment.

AFC Code Global Code Meaning

BT TP Beyond Truck

LD OK Delivered

RF RT Refused

TG SS Terminated at Gateway

*CS CS Closed Shipment

*BR BR Cleared and Delivered by Customs Broker

*DD *DD Delivered Damaged

*DS DS Destroyed/Disposal

* Notates a Global Checkpoint that has been added

Page 17: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 15 of 51 DHL Confidential & Proprietary

6.4 Service Incident Events When ALL shipment status events are requested, every time a new shipment status event is posted to DHL’s global event system, another shipment status record will be created and sent on the next time processing cycle for the customer.

6.5 Custom Select Service Events Customers can select the shipment status event codes that they would like to receive. Please see appendix D for the entire listing of events available and work with your EDI analyst during setup.

Page 18: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 16 of 51 DHL Confidential & Proprietary

Chapter 7 Shipment Status Schedules

7.1 Processing and Schedule Options DHL’s SSI system is designed to be flexible in order to meet the variety of customer needs. As such, there are various options that can be selected for each customer set up on DHL’s Subscription system.

Shipment status files are created based on an extract schedule defined for each customer. As a guideline the number of times a file is sent to a customer should not be greater than number of times the customer picks up or processes the files. A DHL Express EDI analyst will work with you to define an SSI processing schedule based on your needs and volume. Please note that the processing schedule is based on when the processing begins not when files will be delivered. Processing can take several minutes based on DHL’s shipment volume.

Page 19: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 17 of 51 DHL Confidential & Proprietary

Chapter 8 EDI Compliance Testing

8.1 SSI Testing It is the customer’s responsibility to complete an appropriate amount of testing and inform DHL when their systems are ready to receive the SSI files.

SSI testing includes the following steps:

Customer sign and return the SSI trading partner agreement via fax to 480-907-2220.

DHL will provide EDI shipment status test files using live shipments whenever possible.

Customers are responsible for testing the file receipt/communication process, mapping to selected file format and loading data into internal processing system.

The customer must submit a change request if additional account numbers need to be added to an existing SSI feed. Contact the DHL account manager or the DHL EDI analyst to request the change.

Page 20: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 18 of 51 DHL Confidential & Proprietary

Chapter 9 Resources

9.1 Who to Contact

Who To Contact Type of Help

New Activations:

[email protected]

New SSI setup questions

SSI testing questions

Product Support:

[email protected]

Terminate an existing SSI feed

SSI data issues for production files

Missing SSI file or to request a replacement file

SSI file transport issue

Change file transport method, transport location, frequency of SSI file delivery or customer contact information

Add or remove account number(s) to an existing SSI feed

Content issues

Page 21: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 19 of 51 DHL Confidential & Proprietary

Chapter 10 SSI Format04

10.1 Data Structure DHL’s customers use Proprietary Format 4 to receive shipment status information from DHL. Each record is 160 bytes long. A single batch header precedes each file, followed by multiple detail records and a single trailer record. One FMT04 record is written out for each waybill shipment status event to be reported.

Batch Header Record

Field Name Location Length Format Remarks

Record Type 1 1 N “1” indicates Batch Header

Remote ID 2 8 A Your “remote” or sign-on ID

POD 12 3 A “POD” stands for Proof Of Delivery, identifies batch header record.

Data Format 15 5 A “FMT04” - internal name of this format

Production Status 20 1 A “P” indicates Production status

Create Date 26 6 N Date batch was created (YYMMDD format)

Create Time 34 4 N Time batch was created (HHMM format)

Filler 38 123 A Always spaces

Record Layout

Field Name Location Length Format Remarks

Record Type 1 1 N “5” indicates an SSI DATA RECORD

Filler 2 1 A Always spaces

Tracking Number 3 11 N DHL Shipment/Way bill Number

Master Invoice Number

14 11 N Null Value

Customer Number

25 11 N DHL Account Number for paying party

Pickup Date 36 6 N Date of shipment pickup (YYMMDD format)

Page 22: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 20 of 51 DHL Confidential & Proprietary

Field Name Location Length Format Remarks

Pickup Time 42 4 N Time of shipment pickup (HHMM format)

Shipment Status Event Code

46 2 A Shipment status event associated with this SSI record. See Appendix D for a list of shipment status event codes.

Event Date 48 6 N Date of shipment status event (YYMMDD format)

Event Time 54 4 N Time of shipment status event (HHMM format)

Number of Pieces

58 5 N Number of pieces per tracking number.

Signature/ Comment

63 30 A Delivery information or comments for shipment status events.

If Shipment Status Event Code (position 46 & 47) is a “Final” shipment status event, a Signature Sub Code may be found in positions 24 through 25 of this field. See Appendix C for a list of signature sub codes.

DHL Origin Station

93 3 A Waybill originating station

DHL Destination Station

96 3 A Waybill destination station

Service Indicator 99 1 A N = Express

Product Type Code

100 2 A See Appendix A for a listing of codes

Package Type Indicator

102 1 A See Appendix B for a list of packaging types.

Customer Reference Number

103 25 A Customer reference number

Consignee Name 128 25 A “Who” the package is being sent to

Consignee State 153 2 A State code of Consignee

Consignee Postal Code

155 6 N Postal code of Consignee if US or Canadian destination

Page 23: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 21 of 51 DHL Confidential & Proprietary

Batch Trailer Record

Field Name Location Length Format Remarks

Record Type 1 1 A “8” indicates a Batch Trailer

SSI Record Count

2 7 N Number of SSI Data Records prior to this Batch Trailer and after the preceding Batch Header.

Filler 9 152 A Always spaces

Page 24: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 22 of 51 DHL Confidential & Proprietary

Chapter 11 SSI Comma Delimited Format

11.0 Data Structure This is a comma-delimited format. A comma separates each field, making it easy to pull the data into spreadsheet software.

Field Name Location Length Remarks

Batch Date 2 6 Batch create date (YYMMDD format)

Batch Time 11 4 Batch create time (HHMM format)

Batch Record Sequence Number

18 5 Incrementing #1-99999

Tracking Number 26 11 DHL Shipment/Way bill Number

Master Invoice Number

40 11 Null Value

Customer Number 54 11 DHL Customer/Account Number of paying party

Pickup Date 68 6 Date of shipment pickup (YYMMDD format)

Pickup Time 77 4 Time of shipment pickup (HHMM format)

Shipment Status Event Code

84 2 Shipment status event associated with this SSI record See Appendix D for a list of shipment status event codes.

Event Date 89 6 Date of shipment status event (YYMMDD format)

Event Time 98 4 Time of shipment status event (HHMM format)

Number of Pieces 105 5 Number of pieces per tracking number.

Signature/ Comment

113 30 Delivery information or comments for shipment status events.

If Shipment Status Event Code (position 84 & 85) is a “Final” shipment status event, a Signature Sub Code may be found in positions 24 through 25 of this field. See Appendix C for a list of signature sub codes.

Page 25: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 23 of 51 DHL Confidential & Proprietary

Field Name Location Length Remarks

DHL Origin Station 146 3 Waybill origin station

DHL Destination Station

152 3 Waybill destination station

Service Level Indicator

158 1 N = Express

Product Type Code 162 2 See Appendix A for a list of product types.

Packaging Type 167 1 See Appendix B for a list of packaging types.

Customer Reference Number

171 25 Customer reference number

Page 26: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 24 of 51 DHL Confidential & Proprietary

Chapter 12 SSI ANSI 214 Format

12.0 Data Structure The ANSI X12 214 is an across industry standard message defined and managed by the ANSI X12 standards organization. DHL Express supports ANSI X12 214 version 4010. The X12 214 is one of the most widely accepted shipment status message within North America. You can learn more about the ANSI X12 organization by going to their website at www.x12.org.

Shipment status information within the 214 is mapped to elements within “segments.” Segments are a logical grouping of data elements. General information is reported once, (e.g., Tracking number, shipper, consignee, third party, etc.) and loops of LX and AT7 segments are repeated for every shipment status event.

ISA: Interchange Control Header Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

ISA01 01 Authorization Qualifier 2/2 ID Always “00”

ISA02 02 Authorization Information 10/10 AN Blanks

ISA03 03 Security Information Qualifier

2/2 ID Always “00”

ISA04 04 Security Information 10/10 AN Blanks

ISA05 05 Interchange ID Qualifier 2/2 ID 01 = Duns Number

ZZ = Mutually defined

ISA06 06 Interchange Sender ID 15/15 AN Assigned by sender

ISA07 05 Interchange ID Qualifier 2/2 ID 01 = Duns Number

12 = Phone (Phone Co’s)

16 = Duns +4

ZZ = Mutually defined

ISA08 07 Interchange Receiver ID 15/15 AN Assigned by receiver

ISA09 08 Interchange Date 6/6 DT YYMMDD

ISA10 09 Interchange Time 4/4 TM HHMM

ISA11 10 Interchange Control Standards Identifier

1/1 ID Always “U”

ISA12 11 Interchange Control Version #

5/5 ID 00400

Page 27: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 25 of 51 DHL Confidential & Proprietary

ISA13 12 Interchange Control # 9/9 N0 Assigned by sender. Together with Sender ID (ISA06), uniquely identifies interchange data to receiver.

ISA14 13 Acknowledgement Requested

1/1 ID 1 = Yes

0 = No

ISA15 14 Usage Indicator 1/1 ID T = Test data

P = Production data

ISA16 15 Component Element Separator

1/1 AN Mutually defined delimiter; value must be different than the data element separator and the segment terminator.

GS: Functional Group Header

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

GS01 479 Functional Identifier Code 2/2 ID Always “QM”

GS02 142 Applications Sender’s Code

2/15 AN Defined by DHL

GS03 124 Applications Receiver’s Code

2/15 AN Defined by Receiver

GS04 373 EDI Date 8/8 DT Run Date. (CCYYMMDD)

GS05 337 EDI Time 4/8 TM Run Time. (HHMM)

GS06 28 Group Control Number 1/9 N0 Assigned number originated & maintained by the sender

GS07 455 Responsible Agency Code

1/2 ID X = ASC

GS08 480 EDI Version Number 1/12 AN 004010

ST: Transaction Set Header

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

ST01 143 Transaction Set ID Code 3/3 ID “214”

ST02 329 Transaction Set Control # 4/9 AN Incrementing # 1-999999999

B10: Beginning Segment Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

Page 28: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 26 of 51 DHL Confidential & Proprietary

B1001 127 Reference Identification 1/30 AN Shipment Level: DHL AWB#

Piece Level: DHL Piece Identification #.

B1002 145 Shipment Identification Number

1/30 AN Shipper Reference Number or “None” if not provided

B1003 140 Standard Carrier Alpha Code

2/4 ID Always “DHLC”

L11: Reference Number

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

L1101 127 Reference Identification 1/30 AN DHL Customer/Account Number of paying party

Shipment Level: DHL AWB#

L1102 128 Reference Identification Qualifier

2/3 ID 11=Account number

AW = Airway Bill Number

(Beginning of 0100 Loop, up to 10 occurrences)

N1: Name

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

N101 98 Entity Identifier Code 2/3 ID SH=Shipper CN=Consignee BT=Bill to Party

N102 93 Name 1/60 AN Customer Name or “None” if not provided. DHL max length = 25.

N103 66 Identification Code Qualifier 1/2 ID 25 = Customer Code

N104 67 Identification Code 2/80 AN DHL Customer Number

N3: Address Information

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

N301 166 Address 1/55 AN Address of N1. DHL max length = 25.

Page 29: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 27 of 51 DHL Confidential & Proprietary

N302 166 Address 1/55 AN Additional address of N1.

DHL max length = 25.

N4: Geographic Location

Page 30: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 28 of 51 DHL Confidential & Proprietary

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

N401 19 City Name 2/30 AN City of N1 or “None” if CityName and State or Province Code not provided. DHL max length = 20.

N402 156 State or Province Code 2/2 ID State code of N1.

N403 116 Postal Code 3/15 ID Postal code of N1.

DHL max length = 9.

N404 26 Country Code 2/3 ID Country code of N1, if available.

G61: Contact

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

G6101 366 Contact Function Code 2/2 ID AS = Authorized Signature

G6102 93 Name 1/60 AN Signature of individual accepting delivery

G62: Date/Time

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

G6201 432 Date Qualifier 2/2 ID 86 = Actual Pickup Date

G6202 373 Date 8/8 DT Pickup Date (CCYYMMDD)

G6203 176 Time Qualifier 1/2 ID 8 = Actual Pickup Time

G6204 337 Time 4/8 TM Pickup Time (HHMM)

G6205 623 Time Code 2/2 ID LT = Local Time wherever the event occurred

GM = Greenwich Meantime

(End of 0100 Loop)

MS3: Interline Information

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

Page 31: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 29 of 51 DHL Confidential & Proprietary

MS301 140 Standard Carrier Alpha Code (SCAC)

2/4 ID Always “DHLC”

MS302 133 Routing Sequence Code 1/2 ID O = Origin Carrier (Air, Motor or Ocean)

MS304 91 Transportation Method/Type Code

2/2 ID AE = Air Express

(Beginning of 0200 Loop, multiple occurrences)

LX: Assigned Number Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

LX01 554 Assigned Number 1/6 N0 Only one shipping status event per transaction set. The value will always be ‘1’.

Page 32: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 30 of 51 DHL Confidential & Proprietary

(Beginning of 0205 Loop, up to 10 occurrences within the 0200 Loop)

AT7: Shipment Status Details – If Shipping Status event is PU (Pickup), then an additional transaction set will be created to provide the Expected Delivery date.

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

AT701 1650 Shipment Status Code 2/2 ID Shipment Status Event Code. See Appendix D for a list of shipment status event codes. .

AT702 1651 Status Reason Code 2/2 ID Shipment Exception Event Code. Default = NS (Normal Status) if update.

AT705 373 Date 8/8 DT Shipment Status Event Date (CCYYMMDD)

AT706 337 Time 4/8 TM Shipment Status Event Time (HHMM)

AT707 623 Time Code 2/2 ID LT = Local Time

GM = Greenwich Meantime

MS1: Shipment Location

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

MS101 19 City Name 2/30 AN Shipment Status Event City if available, otherwise “Unknown”

MS102 156 State or Province Code 2/2 ID Shipment Status Event State if available, otherwise “XX”

MS103 26 Country Code 2/3 ID Shipment Status Event Country if available.

(End of 0205 Loop)

K1: Remarks

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

K101 61 Free-Form Message 1/30 AN DHL Shipment Status Event Code Description from see appendix E.

K102 61 Free-Form Message 1/30 AN DHL Shipment Exception Event Code Description see appendix

Page 33: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 31 of 51 DHL Confidential & Proprietary

AT8: Shipment Weight, Packaging and Quantity

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

AT801 187 Weight Qualifier 1/2 ID G=Gross Weight

AT802 188 Weight Unit Code 1/1 ID L=Pounds

AT803 81 Weight 1/10 R Actual shipment weight

AT804 80 Lading Quantity 1/7 N0 Number of pieces

(Beginning of 0210 Loop, multiple occurrences within the 0200 Loop)

CD3: Carton (Package) Detail Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

CD304 34 Service Standard 1/4 N1 Null Value

CD305 284 Service Level Code 2/2 ID See Appendix A

CD309 122 Rate/Value Qualifier 2/2 ID No Data will be passed

CD310 58 Charge 1/12 N2 No Data will be passed

(End of 0210 Loop) (End of 0200 Loop)

SE: Transaction Set Trailer

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

SE01 96 Number of Included Segments

1/10 N0 Total number of segments included in the transaction set including ST and SE segments

SE02 329 Transaction Set Control Number

4/9 AN Matches the ST02 control number

GE: Functional Group Trailer

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

GE01 97 Number of Transaction Sets Included

1/6 N0 Total number of transaction sets included

GE02 28 Group Control Number 1/9 N0 Matches the GS06 control number

Page 34: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 32 of 51 DHL Confidential & Proprietary

IEA: Interchange Control Trailer

Segment Number

Data Nbr.

Element Name Size Min/Max

Field Type

Remarks

IEA01 I16 Number of Included Functional Groups

1/5 N0 Total number of functional groups included

IEA02 I12 Interchange Control Number

9/9 N0 Must be the same as the ISA13 control number

12.1 ANSI X12 Setup Information The customer needs to provide the ISA08 and GS03 IDs for test and production. The remaining ISA and GS should also be identified if the defaults defined below do not work for the customer.

Segment Description Default ISA05 Interchange ID Qualifier ZZ ISA06 Interchange Sender ID DHLCSSI ISA07 Receiver ID Qualifier ZZ

ISA08 Interchange Receiver ID ‘DHLC’ for production ‘DHLT’ for test

GS02 Group Sender ID DHLCSSI GS03 Group Receiver ID

Page 35: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 33 of 51 DHL Confidential & Proprietary

Chapter 13 DHL SHIPTNR Format

13.0 Data Structure SHIPTNR SSI format is made up of 2 record types: Shipment and Customer Reference. Shipment records have a value of ‘S’ in the first position. Customer Reference records have a value of ‘R.’ The reference record indicates if the data element is applicable to “D” for Domestic, “I” for International, or “B” for both.

The SHIPTNR format has a record length of 1000 bytes.

13.1 Customer Reference Record

Field Start End Length Value Remarks

Record Type 1 1 1 R

Tracking Number 2 14 13 DHL Shipment/Way bill Number

Pickup Date 15 24 10 Date of Shipment Pickup

Customer Type 25 33 9 SHIPPER or CONSIGNEE

Customer Number 34 44 11 DHL Customer/Account Number of paying party

Customer Name 45 69 25 Customer Name

Customer Reference Number 70 94 25 Customer Reference Number

Filler 95 988 894

Trading Partner ID 989 1000 12

13.2 Shipment Record

Field Start End Length Value Remarks

Record Type 1 1 1 S

Tracking Number 2 14 13 DHL Shipment/Way bill Number

Pickup Date 15 24 10

DHL Origin Station 25 27 3 Waybill originating station

DHL Destination Station 28 30 3 Waybill destination station

Number of Pieces 31 37 7 Number of pieces

Chargeable Weight 38 48 11

Page 36: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 34 of 51 DHL Confidential & Proprietary

Field Start End Length Value Remarks

Actual Weight 49 55 7 ‘Weight submitted by shipper’

Weight Unit of Measure 56 64 9

Master Bill 65 73 9

Airline Code 74 76 3

Flight 77 82 6

Export Date 83 92 10

Import Date 93 102 10

Arrival (yes/no) 103 103 1 YES if shipment status event code is BN or IB, otherwise NO.

Bill To Party 104 110 7

R = Receiver, S = Shipper, 3 = Bill to Party

Freight Charges 111 121 11 Null Value

Miscellaneous Charges 122 132 11 Null Value

Total Charges 133 143 11 Null Value

Customs Value 144 154 11

Currency Type 155 157 3

Shipper Number 158 168 11 DHL Shipper Customer Number/Account Number. Only provided if you are the “bill to” customer.

Shipper Name 169 193 25

Consignee Number 194 204 11 DHL Consignee Customer Number/Account Number. Only provided if you are the “bill to” customer.

Consignee Name 205 229 25

Payer Number 230 240 11 Payer Account Number

Payer Name 241 265 25 Null Value

Product Type Code 266 267 2 See Appendix A

Mode 268 272 5 “Air”

Service Type 273 274 2 EX - Express

Broker Pickup Date 275 284 10

Broker Return Date 285 294 10

Customs Clearance Date 295 304 10

Broker Notify Date 305 314 10

Storage (yes/no) 315 315 1

Hold Date 316 325 10

Off Hold Date 326 335 10

Shipment Status Event Code and description

336 365 30 See Appendix D (DHL Disposition) for codes and descriptions

Page 37: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 35 of 51 DHL Confidential & Proprietary

Field Start End Length Value Remarks

Signature/comments 366 395 30 Delivery information or comments for shipment status events.

If Shipment Status Event Code (position 336 & 337) is a “Final” shipment status event, a Signature Sub Code may be found in positions 24 through 25 of this field. See Appendix C for a list of signature sub codes.

Final Shipment Status Event Signature/comments

396 425 30 Delivery information or comments for ‘final’ Shipment Status When populated, this field will contain the same value as the signature/comments field.

Delivery Date 426 435 10

Event Date 436 445 10 Shipment Status Event Date

Event Time 446 450 5 Shipment Status Event Time

Dim/Reweigh 451 451 1 D – If shipment dimmed R – If shipment was reweighed

SDS Code 452 452 1 Null Value

Domestic/International Code 453 453 1 D = domestic I = International

Expected Delivery Date 454 463 10 Populated from corresponding field on waybill, if not blank.

Expected Delivery Time 464 468 5 Populated from corresponding field on waybill, if not blank.

Shipper Address 1 469 493 25

Shipper Address 2 494 518 25

Shipper Address 3 519 543 25

Shipper City 544 563 20

Shipper State 564 565 2

Shipper Postal Code 566 575 10

Shipper Country 576 595 20

Shipper Reference 596 620 25 Shipper Reference/PO Number

Consignee Address 1 621 645 25

Consignee Address 2 646 670 25

Consignee Address 3 671 695 25

Consignee City 696 715 20

Consignee State 716 717 2

Consignee Postal Code 718 727 10

Consignee Country 728 747 20

Consignee Reference 748 772 25 Null Value

Pickup Time 773 777 5

Shipment Description 778 817 40

Third Party Address 1 818 842 25 Null Value

Page 38: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 36 of 51 DHL Confidential & Proprietary

Field Start End Length Value Remarks

Third Party Address 2 843 867 25 Null Value

Third Party Address 3 868 892 25 Null Value

Third Party City 893 912 20 Null Value

Third Party State 913 914 2 Null Value

Third Party Postal Code 915 924 10 Null Value

Third Party Country 925 944 20 Null Value

Filler 945

Event Station Code 984 986 3 3 character DHL station code associated to the Shipment Status Event

Payment Method 987 987 1 U = UNRATED

Package Type Code 988 988 1 L = LETTER EXP O = EXPRESS OTHER

Trading Partner ID 989 1000 12

Page 39: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 37 of 51 DHL Confidential & Proprietary

Appendix A: Product Type Product Type Code associated to DHL Express service.

Code Description

9A Express 9 a.m.

AE Air Economy

AC Break Bulk Express

BC Global Mail Business

CG International Ground

CX Express Worldwide

ES Import Express Flex

FC Express Easy

GP Medical Express

IE Express Worldwide

IX Economy Select (EU)

MW Break Bulk Economy

NS Non-Service

ON Domestic Express

PA Express (10:30 A.M)

PB Express Envelope

PN Express (12:00 A.M)

R5 Freight Worldwide

RS Auto Reversals

SA Same Day

ST Domestic Economy Select

Page 40: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 38 of 51 DHL Confidential & Proprietary

Appendix B: Packaging Type

Some package types can be associated to a service level.

Code Description

B DHL Express Other

L Letter Express

T Customer Packaging

V Multi Piece Packaging

Page 41: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 39 of 51 DHL Confidential & Proprietary

Appendix C: Signature Sub Codes The Signature/Comment field often contains a two-character sub-code in 24th and 25th positions for “final” shipment status events. Final shipment status events are defined in the Shipment Status Event Code appendix. This code is used to indicate the type or source of the signature.

Code Description

DR Left at Door

GD Guard

MR Mailroom

SD Shipping Dock

RC Receptionist

OT Other

RA Residential - Alternative Address

RD Residential - Left at Door

RS Residential - Left other than at door

RG Residential - Left with Guard

Page 42: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 40 of 51 DHL Confidential & Proprietary

Appendix D: Shipment Status Event Codes The following summary describes shipment status event codes used by DHL and their meanings. An asterisk indicates a new event code. All SSI trading partners setup after July 15th 2009 will be using the global codes.

Global Code

Legacy Code

214 Code Event Description Event Type

AD IB X2 Agreed Delivery Progress

AF AF X4 Arrived Facility Progress

AR IB X1 Arrived in Delivery Facility Progress

BA AD AH Bad Address Service Incident

BN BN K1 Customer Broker Notified Progress

BR BR BA Cleared and Delivered by Custom’s Broker

Completion

CA AD AH Closed on Arrival Service Incident

CC HA AV Awaiting Consignee Collection Progress

CD GH PR Controllable Clearance Delay Service Incident

CM AD AH Customer Moved Service Incident

CR CC L1 Clearance Release Progress

* CS CS CA Closed Shipment Completion

* DD DD A9 Delivered Damaged Completion

DF DF P1 Depart Facility Progress

Page 43: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 41 of 51 DHL Confidential & Proprietary

Global Code

Legacy Code

214 Code Event Description Event Type

* DS DS CA Destroyed/Disposal Completion

FD BD J1 Forwarded to Third Party Delivery Agent – Delivery Details Expected

Progress

HP DH SD Held for Payment Service Incident

IC TB K1 In Clearance Processing Progress

MC TU SD Miscode Service Incident

MD NL SD Missed Delivery Cycle Service Incident

MS TU SD Missort Service Incident

NH AD AP Not Home Service Incident

PD PT AP Partial Delivery Completion

OH OH BC On Hold Service Incident

OK LD D1 Delivery Completion

PL PL X3 Processed at Location Progress

PU PU AF Shipment Pickup Progress

RD RF A7 Refused Delivery Service Incident

RT RF A3 Returned to Consignor Completion

* SA SA XB Shipment Acknowledged Progress

SC TU AI Service Changed Service Incident

SS TG CA Shipment Stopped Completion

TP BT X6 Forwarded to a Third Party – No Delivery Details Expected

Completion

* TR TR CL Record of Transit Progress

UD GH PR Uncontrollable Clearance Delay Service Incident

WC OD AJ With Delivery Courier Progress

Page 44: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 42 of 51 DHL Confidential & Proprietary

Appendix F: Shipment Exception Event Codes The following summary describes Shipment Exception Event Codes used by DHL, their meanings and translation to ANSI X12 214 Status Reason Codes. In the 214 format, the ANSI Reason Code is shown in the AT702 segment and the DHL Exception Code Description is shown in the K102 segment, when applicable.

Reason Code

Service Incident Description

A2 COMPANY NOT AT ADDRESS INCORRECT CITY/TOWN INCORRECT COUNTRY INCORRECT POST CODE INCORRECT STREET NUMBER NO CONTACT NAME NO EXTENSION NUMBER PO BOX ONLY UNKNOWN PERSON AT ADDRESS UNKNOWN STREET

A3 Neighbor <name> A5 GUEST CHECKED OUT AA

ROUTE MISSORT MISSED CONNECTION MOVEMENT CANCELLED NO FURTHER UPLIFT AVAILABLE TO DESTINATION NO MOVEMENT SCHEDULED FOR DESTINATION WRONG ROUTE

AD

<No of Deliveries Attempted>DELIVERY ATTEMPTED<Expected Date in Format DDMM> AM or PM

CARD MAILED GUEST NOT REGISTERED LEFT CARD<Card Number> MSG PHONED NOT CHECKED IN CAN’T LEAVE A CARD CONSIGNEE RESCHEDULED DELIVERY <Expected Date of Delivery Attempt in Format

DDMM> AWAITING DELIVERY DELIVERY SCHEDULED <Expected Delivery Date In Format DDMM> AM or PM

AE

USED FOR SHOES, TEXTILES AND OTHER WEARING APPAREL THAT MAY HAVE SPECIAL CLEARANCE REQUIREMENTS

DANGEROUS GOODS – NON CONFORMING DESTINATION IMPORT RESTRICTION

AF TOTAL LOSS OF TRUCK/AIRCRAFT

Page 45: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 43 of 51 DHL Confidential & Proprietary

Reason

Code Service Incident Description

AG

NEW CONSIGNEE INFORMATION REQUIRED <Number of Delivery Attempt> DELIVERY ATTEMPT <Expected Date in Format DDMM> AM or

PM NEW CONTACT INFORMATION REQUIRED COMPANY MOVED CONSIGNEE MOVED NEW CONTACT INFORMATION REQUIRED NEW CONTACT INFORMATION REQUIRED DENIED TIMELY ACCESS NO IDENTIFICATION NEW CONTACT INFORMATION REQUIRED DENIED ACCESS NEW CONSIGNEE INFORMATION REQUIRED NO EXCHANGE UNIT AWAITING INSTRUCTIONS FROM <Consignee/Consignor> INACCURATE CONSIGNEE DETAILS INSTRUCTED BY CONSIGNEE/CONSIGNOR

AH COURIER WORK LOAD (NO TIME TO DELIVER) AI

VEHICLE PROBLEM VEHICLE BREAKDOWN

AJ

EXCEEDS MAXIMUM WEIGHT OR DIMENSIONS (NON CONVEYABLE) OFFLOAD TECHNICAL FAULT

AK

DAMAGE IDENTIFIED DAMAGED

AN

CONSIGNEE ON HOLIDAY UNTIL <Expected Date of Return in Format DDMM> INDICATED HOLIDAY <DDMM> LOCAL HOLIDAY <DDMM> PUBLIC HOLIDAY <DDMM> CONSIGNEE ON HOLIDAY UNTIL <Expected Date Of Return In Format DDMM> INDUSTRIAL HOLIDAY UNTIL <Expected Date Of Return In Format DDMM> NO MOVEMENT PUBLIC HOLIDAY AT DESTINATION PUBLIC HOLIDAY UNTIL <Scheduled Delivery In Format DDMM>

AO

BAD WEATHER WEATHER SEVERE WEATHER NATURAL DISASTER

AQ

DELIVERY ATTEMPT BEFORE BUSINESS HOURS LUNCH PERSONAL DELIVERY

Page 46: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 44 of 51 DHL Confidential & Proprietary

Reason

Code Service Incident Description

AR

AWAITING CONSIGNOR PAPERWORK EXCEEDED VALUE LIMIT EXPORT LICENSE REQUIRED DHL HAS STOPPED THIS SHIPMENT DUE TO AN INNACURATE OR INCOMPLETE

INVOICE INACCURATE CONSIGNEE DETAILS MUST VERIFY MARKED OR MUTILATED CLEARANCE PROCESSING - EXCEEDS VALUE LIMIT IN SERVICE DIRECTORY AND

OTHER EXISTING STANDARD REMARKS DO NOT APPLY PAPERWORK MISSING <TYPE OF PAPERWORK> PIECE MISSING REPAIR AND RETURN ENTRIES CONTENTS MISSING MISSSING PAPERWORK <Type of paperwork> MISSING PAPERWORK NO SHIPMENT DETAIL RECEIVED NO PRE ALERT RECEIVED PIECE MISSING

AS

SHIPMENT WITH NO PRE-ALERT OR ALERTED BUT NOT MANIFESTED CORRECTLY SHIPMENT TO BE TRANSFERRED BETWEEN TWO DHL BONDS SHIPMENT NOT CLEARED DUE TO MISSING IMMAGE. WAREHOUSE TO PULL

PAPERWORK AND IMAGE BEFORE PUTTING INTO BOND. STATUS SHOULD BE CHANGED AS SOON AS PAPERWORK IMAGES ARE CAPTURED

AU

ACT OF WAR / TERRORISM IMMEDIATE EMBARGO SPECIFIC GOVT / AUTH COMMAND

B1 B4

NOT OPEN PAYMENT REQUIRED <Type of Payment> <Currency Code><Amount> DUTY GST SALES TAX TOTAL VALUE TRANSPORT COLLECT VAT

B9

OUTSIDE AGREED DAYS LATE DAYS OUTSIDE AGREED HOURS LATE HOURS

BC AWB MISSING BE HEAVY TRAFFIC BG DHL REQUEST

FM <Delay reason for FM> REPACK SERVICE

BL 3RD PARTY INDUSTRIAL ACTION – LEGAL / SAFETY RESTRICTIONS

Page 47: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 45 of 51 DHL Confidential & Proprietary

Reason

Code Service Incident Description

BS CONSIGNEE REQUEST <Type of Payment> <Currency Code> <Amount> NOT ORDERED OR REQUIRED <Name of Consignee who Refused> IMPORT DUTY GST SALES TAX TOTAL VALUE

C2 CREDIT STOP C5 INDUSTRIAL ACTION

CIVIL UNREST C8 TRANSPORT COLLECT P1 ARRIVED TOO LATE TO MAKE CONNECTION P2 SHIPMENTS HELD FOR PAPERWORK INSPECTION BY CUSTOMS

INSPECTION BY <Name Of Regulatory Authority> SECURITY INSPECTION FAILED

S1 CONTENTS SHORT PIECE MISSING AND DELIVERY REFUSED

Page 48: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 46 of 51 DHL Confidential & Proprietary

Glossary

Terminology

Term DHL Definition

Account Number A unique number assigned to a DHL customer. Large customers may have multiple account numbers, assigned to different physical locations, department, etc.

Actual Weight The measured heaviness of a package provided by the shipper. This is typically determined by placing the package on a scale or similar device.

Chargeable Weight Weight used to calculate the freight charge and is the greater of the actual or dimensional weight.

Dimensional Weight A value derived by the following formula: (L x W x H)/D, where L is package length, W is package width, H is package height, and D is a dimensional factor (usually 194 for domestic shipments and 166 for international shipments).

Freight Charge Price calculated based on the cost to move a shipment from origin to destination based on chargeable weight.

Item Number A 10 digit number assigned to a shipment or fee

Length The longest side of a package.

Piece A physical package.

Trading Partner A customer or third-party entity that is configured to send or receive electronic data with DHL.

Girth The distance around a package at its widest and highest point, measured at a right angle to the package length. In other words: girth = (2 x width) + (2 x height).

Page 49: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 47 of 51 DHL Confidential & Proprietary

Revision History

Rev. # Release Date Updated by Reason for Update Status

1.0 10/27/05 Omar Douglas DHL branded baseline document. Approved

1.1 1/10/06 Omar Douglas Updated the 214 MS304 remarks by adding the logic used to derive Transportation Method/Type Code.

Approved

1.2 2/24/06 Omar Douglas Defined positions 984-988 of the SHIPTNR format which were previously defined as “filler”.

Event Station Code 984-986

Payment Method 987-987

Package Type Code 988-988

Approved

1.2 4/12/06 Omar Douglas Updated conditional logic in 214 N101 segment to align with what is actually occurring. City of N1 or “None” if City Name and State or Province Code are blank.

Approved

1.3 2/21/07 Annie Richardson Updated disposition codes to include the following:

DHL Code X12 Code

AF X4

DF P1

PL L1

Approved

8.0 5/27/08 Annie Richardson Update Version

Update Format

Remove DDU information

Page 50: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 48 of 51 DHL Confidential & Proprietary

Rev. # Release Date Updated by Reason for Update Status

9.04 7/15/09 Annie Richardson Updated specification format

Update Appendix F to include codes that relate to global events

Update Appendix A to include global products

Update Appendix B

Removed At Home dispositions

Changed testing requirements

Added Terminology section

Added contact section

Noted domestic elements no longer being used as ‘NULL VALUE”

o Freight Charges o Miscellaneous Charges o Total Charges o Payer Name o SDS Code o Consignee Reference o Third Party Address 1 o Third Party Address 2 o Third Party Address 3 o Third Party City o Third Party State o Third Party Postal Code o Third Party Country o Master Invoice Number

12.01 March 5, 2012 Thomas Lee Section 5.1 - Secure Protocol updated

13.01 August 1, 2017 John Mihaiu Chapter 12 – 214 mapping specs changes to allow both Shipment level and piece level mapping.

Segments B10, LX, AT7 updated

EDD – Estimated date of delivery now provided

One transaction set per event.

13.01 October 4, 2017 John Mihaiu Section 12.0 - SSI ANSI 214 Format

Updated specification format to accommodate shiplevel mapping and pc level mapping. Map names are: TPCX_214_EDD-1N1 (shipment level) TPCX_214_EDD-1N1_RAW (pc level)

Continued next page.

Page 51: DHL Shipment Status Interchange (SSI) Specification v13 · DHL Confidential & Proprietary Confidentiality The specifications, definitions and examples in this manual are to be used

Jan 2, 2018 SSI v13.02 Page 49 of 51 DHL Confidential & Proprietary

13.01 October 4, 2017 John Mihaiu B10 Segment – B10.01 data element - Value populated is either AWB# (shipment level) or License Plate# (pc level) dependant on which map is used. LX Segment - LX.01 Value will always be “1” as only one event per transaction set is transmitted. AT7 Segment – If Shipping Status event is PU (Pickup), then an additional transaction set will be created to provide the Expected

13.02 January 2, 2018 John Mihaiu Integration level changes: Shipment level and pc level ANSI X12 maps include the following changes. Map names are: TPCX_214_EDD-1N1 (shipment level) TPCX_214_EDD-1N1_RAW (pc level) Changes are:

1. Delimiters can now be changed to reflect those needed by the customer. They are:

o Element delimiter, o Sub Element delimiter o Segment Terminator.

2. Date time stamp of the status

event can be configured for either Local time (LT) or Greenwich Meantime (GM). Default is LT.

Mapping change: Pc Level map change. Map names are: TPCX_214_EDD-1N1_RAW (only) Changes are:

3. L11 segment has been added to provide the Shipment level Airway Bill# to complement the License Plate# provided in the B10.01 data element (Piece id). The qualifier in the L11.02 data element is: AW.

Specifications Section# 5.3:

4. Corrected retention of data. Now only 30 days.