Shipping Package - XML 7/9/2012 Shipping Package XML Developers Guide July 9, 2012 © 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 1 Shipping Package - XML 7/9/2012 Notice In all communications with UPS concerning this document, please refer to the document date located on the cover. Copyright The use, disclosure, reproduction, modification, transfer, or transmittal of this work for any purpose in any form or by any means without the written permission of United Parcel Service is strictly prohibited. © Copyright 2012 United Parcel Service of America, Inc. All Rights Reserved. Trademarks Some of the UPS corporate applications use U.S. city, state, and postal code information obtained by United Parcel Service of America, Inc. under a non-exclusive license from the United States Postal Service. © 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 2 Shipping Package - XML 7/9/2012 Table of Contents 1.1 Important Information...............................................................................................................6 1.2 Welcome to the UPS API Developer's Guides..........................................................................7 1.2.1 Release features........................................................................................................................7 1.2.2 How to Use this Guide .......................................................................................................12 1.3 Business Processes and Rules...................................................................................................12 1.4 Required Steps for Integrating................................................................................................13 1.5 Planning Your Applications for XML ....................................................................................13 1.5.1 UPS Developer API Applications .....................................................................................13 1.5.2 Licensing the UPS Developer APIs ..................................................................................15 1.5.2.1 Branding Requirements...............................................................................................16 1.5.3 Developing Client Applications for Developer APIs.......................................................16 1.5.3.1 Microsoft Visual Studio ...............................................................................................16 1.5.3.2 Java Standard Edition and Enterprise Edition...........................................................16 1.5.3.3 Open Source .................................................................................................................16 1.5.4 Getting Technical Support................................................................................................17 1.5.6 Keeping Up-to-Date ...........................................................................................................20 1.6 UPS Developer API Technologies for XML ...........................................................................20 1.6.1 Hypertext Transfer Protocol and Secure Sockets Layer 3.............................................20 1.6.2 Working with HTTP and SSL in Application Programs...............................................22 1.6.2.1 Microsoft Visual Studio ...............................................................................................25 1.6.2.2 Java Standard Edition and Enterprise Edition...........................................................25 1.6.2.3 Open Source .................................................................................................................26 1.6.3 Extensible Markup Language (XML)..............................................................................26 1.6.4 Working with XML in Application Programs ................................................................29 1.6.4.1 Microsoft Visual Studio ...............................................................................................29 1.6.4.2 Java Standard Edition and Enterprise Edition...........................................................31 1.6.4.3 Open Source .................................................................................................................31 1.7 Understanding XML Shipping Services .................................................................................32 1.7.1 What Shipping Services Can Do.......................................................................................32 1.7.1.1 Shipments .....................................................................................................................33 1.7.1.2 Cancellations (Voids)...................................................................................................33 1.7.1.3 Returns .........................................................................................................................33 1.7.2 How Shipping Services Work ...........................................................................................33 1.7.2.1 Two Step (Phase) Shipping Process ............................................................................34 1.7.2.2 Forward and Return Shipments..................................................................................34 1.7.2.3 Cancellations (Voids)..................................................................................................36 1.8 The Shipping XML Reference .................................................................................................37 1.8.1 Describing XML Messages................................................................................................37 1.8.2 Authenticating Client Applications..................................................................................43 1.8.3 Shipment Confirm Request...............................................................................................45 1.8.4 Shipment Confirm Response ..........................................................................................140 © 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 3 Shipping Package - XML 7/9/2012 1.8.5 Shipment Accept Request................................................................................................147 1.8.6 Shipment Accept Response .............................................................................................148 1.9 The Void XML Reference ......................................................................................................164 1.9.1 Describing XML Messages..............................................................................................164 1.9.2 Authenticating Client Applications................................................................................164 1.9.1 Void Shipment Request .......................................................................................................165 1.9.2 Void Shipment Response.....................................................................................................167 1.10 Understanding XML Label Recovery Services..................................................................171 1.11 The Label Recovery XML Reference..................................................................................171 1.11.1 Describing XML Messages............................................................................................171 1.11.2 Authenticating Client Applications..............................................................................171 1.11.3 Label Recovery Request....................................................................................................172 1.11.4 Label Recovery Response..................................................................................................175 1.12 Customer Integration Environment....................................................................................180 1.12.1 Negotiated Rates.............................................................................................................180 1.12.1.1 Shipping....................................................................................................................180 1.12.1.2 Verifying Shipping Rates.........................................................................................180 1.12.2 Testing and Deploying Applications.............................................................................181 1.12.2.1 System Availability ...................................................................................................181 1.12.2.2 Server Availability Check.........................................................................................181 1.12.3 UPS Product Exchange Service ........................................................................................182 1.12.4 Production Access ..............................................................................................................182 1.12.5 Label Verification for Contract Services.........................................................................183 1.12.6 Other Shipping API ...........................................................................................................184 1.12.6.1 Voiding Package Shipments ....................................................................................184 1.12.6.2 Label Recovery .........................................................................................................185