Got the track, create shipment, and delete shipment requests in what should be their final forms. Shipment creation is very verbose now, which is good or bad depending on how you like your code to look. It should very closely follow the Fedex API now, though. Shipment deletion is now in usable state. The examples directory has been improved as a whole.

Author: Greg Taylor

examples/create_shipment.py

@@ -9,22 +9,15 @@
 """
 import logging
 import binascii
+from example_config import CONFIG_OBJ
 from fedex.services.ship_service import FedexProcessShipmentRequest
-from fedex.config import FedexConfig
 
 # Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.ERROR)
-
-# FedexConfig objects should generally only be instantiated once and re-used
-# amongst different queries. They hold static data like account number.
-config_obj = FedexConfig(key='ZyNQQFdcxUATOx9L',
-                         password='GtngmKzs4Dk4RYmrlAjrLykwi',
-                         account_number='510087780',
-                         meter_number='118501898',
-                         use_test_server=True)
+logging.basicConfig(level=logging.INFO)
 
 # This is the object that will be handling our tracking request.
-shipment = FedexProcessShipmentRequest(config_obj)
+# We're using the FedexConfig object from example_config.py in this dir.
+shipment = FedexProcessShipmentRequest(CONFIG_OBJ)
 
 # This is very generalized, top-level information.
 # REGULAR_PICKUP, REQUEST_COURIER, DROP_BOX, BUSINESS_SERVICE_CENTER or STATION
@@ -43,53 +36,53 @@
 shipment.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
 
 # Shipper contact info.
-shipment.ShipperContact.PersonName = 'Sender Name'
-shipment.ShipperContact.CompanyName = 'Some Company'
-shipment.ShipperContact.PhoneNumber = '9012638716'
+shipment.RequestedShipment.Shipper.Contact.PersonName = 'Sender Name'
+shipment.RequestedShipment.Shipper.Contact.CompanyName = 'Some Company'
+shipment.RequestedShipment.Shipper.Contact.PhoneNumber = '9012638716'
 
 # Shipper address.
-shipment.ShipperAddress.StreetLines = ['Address Line 1']
-shipment.ShipperAddress.City = 'Herndon'
-shipment.ShipperAddress.StateOrProvinceCode = 'VA'
-shipment.ShipperAddress.PostalCode = '20171'
-shipment.ShipperAddress.CountryCode = 'US'
-shipment.ShipperAddress.Residential = True
+shipment.RequestedShipment.Shipper.Address.StreetLines = ['Address Line 1']
+shipment.RequestedShipment.Shipper.Address.City = 'Herndon'
+shipment.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'VA'
+shipment.RequestedShipment.Shipper.Address.PostalCode = '20171'
+shipment.RequestedShipment.Shipper.Address.CountryCode = 'US'
+shipment.RequestedShipment.Shipper.Address.Residential = True
 
 # Recipient contact info.
-shipment.RecipientContact.PersonName = 'Recipient Name'
-shipment.RecipientContact.CompanyName = 'Recipient Company'
-shipment.RecipientContact.PhoneNumber = '9012637906'
+shipment.RequestedShipment.Recipient.Contact.PersonName = 'Recipient Name'
+shipment.RequestedShipment.Recipient.Contact.CompanyName = 'Recipient Company'
+shipment.RequestedShipment.Recipient.Contact.PhoneNumber = '9012637906'
 
 # Recipient address
-shipment.RecipientAddress.StreetLines = ['Address Line 1']
-shipment.RecipientAddress.City = 'Herndon'
-shipment.RecipientAddress.StateOrProvinceCode = 'VA'
-shipment.RecipientAddress.PostalCode = '20171'
-shipment.RecipientAddress.CountryCode = 'US'
+shipment.RequestedShipment.Recipient.Address.StreetLines = ['Address Line 1']
+shipment.RequestedShipment.Recipient.Address.City = 'Herndon'
+shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'VA'
+shipment.RequestedShipment.Recipient.Address.PostalCode = '20171'
+shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
 # This is needed to ensure an accurate rate quote with the response.
-shipment.RecipientAddress.Residential = True
+shipment.RequestedShipment.Recipient.Address.Residential = True
 
 # Who pays for the shipment?
 # RECIPIENT, SENDER or THIRD_PARTY
-shipment.ShippingChargesPayment.PaymentType = 'SENDER' 
+shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER' 
 
 # Specifies the label type to be returned.
 # LABEL_DATA_ONLY or COMMON2D
-shipment.LabelSpecification.LabelFormatType = 'COMMON2D'
+shipment.RequestedShipment.LabelSpecification.LabelFormatType = 'COMMON2D'
 
 # Specifies which format the label file will be sent to you in.
 # DPL, EPL2, PDF, PNG, ZPLII
-shipment.LabelSpecification.ImageType = 'PNG'
+shipment.RequestedShipment.LabelSpecification.ImageType = 'PNG'
 
 # To use doctab stocks, you must change ImageType above to one of the
 # label printer formats (ZPLII, EPL2, DPL).
 # See documentation for paper types, there quite a few.
-shipment.LabelSpecification.LabelStockType = 'PAPER_4X6'
+shipment.RequestedShipment.LabelSpecification.LabelStockType = 'PAPER_4X6'
 
 # This indicates if the top or bottom of the label comes out of the 
 # printer first.
 # BOTTOM_EDGE_OF_TEXT_FIRST or TOP_EDGE_OF_TEXT_FIRST
-shipment.LabelSpecification.LabelPrintingOrientation = 'BOTTOM_EDGE_OF_TEXT_FIRST'
+shipment.RequestedShipment.LabelSpecification.LabelPrintingOrientation = 'BOTTOM_EDGE_OF_TEXT_FIRST'
 
 package1_weight = shipment.create_wsdl_object_of_type('Weight')
 # Weight, in pounds.
@@ -125,7 +118,7 @@
 # This will show the reply to your shipment being sent. You can access the
 # attributes through the response attribute on the request object. This is
 # good to un-comment to see the variables returned by the Fedex reply.
-#print shipment.response
+print shipment.response
 
 # Here is the overall end result of the query.
 print "HighestSeverity:", shipment.response.HighestSeverity

examples/delete_shipment.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+"""
+This example shows how to delete existing shipments.
+"""
+import logging
+from example_config import CONFIG_OBJ
+from fedex.services.ship_service import FedexDeleteShipmentRequest
+
+# Set this to the INFO level to see the response from Fedex printed in stdout.
+logging.basicConfig(level=logging.INFO)
+
+# This is the object that will be handling our tracking request.
+# We're using the FedexConfig object from example_config.py in this dir.
+del_request = FedexDeleteShipmentRequest(CONFIG_OBJ)
+
+# Either delete all packages in a shipment, or delete an individual package.
+# DELETE_ALL_PACKAGES, DELETE_ONE_PACKAGE
+del_request.DeletionControlType = "DELETE_ALL_PACKAGES"
+
+# The tracking number of the shipment to delete.
+del_request.TrackingId.TrackingNumber = '794798682968'
+
+# What kind of shipment the tracking number used.
+# EXPRESS, GROUND, or USPS
+del_request.TrackingId.TrackingIdType = 'EXPRESS'
+
+# Fires off the request, sets the 'response' attribute on the object.
+del_request.send_request()
+
+# See the response printed out.
+print del_request.response

examples/example_config.py

@@ -0,0 +1,15 @@
+"""
+This file holds various configuration options used for all of the examples.
+"""
+import os
+import sys
+# Use the fedex directory included in the downloaded package instead of
+# any globally installed versions.
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+from fedex.config import FedexConfig
+
+CONFIG_OBJ = FedexConfig(key='ZyNQQFdcxUATOx9L',
+                         password='GtngmKzs4Dk4RYmrlAjrLykwi',
+                         account_number='510087780',
+                         meter_number='118501898',
+                         use_test_server=True)

examples/track_shipment.py

@@ -3,27 +3,28 @@
 This example shows how to track shipments.
 """
 import logging
+from example_config import CONFIG_OBJ
 from fedex.services.track_service import FedexTrackRequest
-from fedex.config import FedexConfig
 
 # Set this to the INFO level to see the response from Fedex printed in stdout.
 logging.basicConfig(level=logging.INFO)
 
-# FedexConfig objects should generally only be instantiated once and re-used
-# amongst different queries. They hold static data like account number.
-config_obj = FedexConfig(key='ZyNQQFdcxUATOx9L',
-                         password='GtngmKzs4Dk4RYmrlAjrLykwi',
-                         account_number='510087780',
-                         meter_number='118501898',
-                         use_test_server=True)
+# NOTE: TRACKING IS VERY ERRATIC ON THE TEST SERVERS. YOU MAY NEED TO USE
+# PRODUCTION KEYS/PASSWORDS/ACCOUNT #.
+# We're using the FedexConfig object from example_config.py in this dir.
+track = FedexTrackRequest(CONFIG_OBJ)
+track.TrackPackageIdentifier.Type = 'TRACKING_NUMBER_OR_DOORTAG'
+track.TrackPackageIdentifier.Value = '798114182456'
 
-# This is the object that will be handling our tracking request.
-track = FedexTrackRequest(config_obj, '798114182456')
 # Fires off the request, sets the 'response' attribute on the object.
 track.send_request()
 
+# See the response printed out.
+print track.response
+
 # Look through the matches (there should only be one for a tracking number
 # query), and show a few details about each shipment.
+print "== Results =="
 for match in track.response.TrackDetails:
-    print "TRACKING #:", match.TrackingNumber
-    print "STATUS:", match.StatusDescription
+    print "Tracking #:", match.TrackingNumber
+    print "Status:", match.StatusDescription

fedex/base_service.py

@@ -63,41 +63,43 @@ def __init__(self, config_obj, wsdl_name, *args, **kwargs):
         @keyword customer_transaction_id: A user-specified identifier to
             differentiate this transaction from others. This value will be
             returned with the response from Fedex.
-        @type carrier_code: L{str}
-        @keyword carrier_code: The carrier code to use for this query. In most
-            cases, this will be FDXE (Fedex Express). Must be one of the
-            following four-letter codes:
-                - FDXC (Fedex Cargo)
-                - FDXE (Fedex Express)
-                - FDXG (Fedex Ground)
-                - FXCC (Fedex Custom Critical)
-                - FXFR (Fedex Freight)
-                - FXSP (Fedex Smartpost)
         """
+        self.logger = logging.getLogger('fedex')
+        """@ivar: Python logger instance with name 'fedex'."""
         self.config_obj = config_obj
+        """@ivar: The FedexConfig object to pull auth info from."""
 
         # If the config object is set to use the test server, point
         # suds at the test server WSDL directory.
         if config_obj.use_test_server:
+            self.logger.info("Using test server.")
             self.wsdl_path = os.path.join(config_obj.wsdl_path, 
                                           'test_server_wsdl', wsdl_name)
         else:
+            self.logger.info("Using production server.")
             self.wsdl_path = os.path.join(config_obj.wsdl_path, wsdl_name)
 
         self.client = Client('file://%s' % self.wsdl_path)
-        self.logger = logging.getLogger('fedex')
+        
+        self.VersionId = None
+        """@ivar: Holds details on the version numbers of the WSDL."""
+        self.WebAuthenticationDetail = None
+        """@ivar: WSDL object that holds authentication info."""
+        self.ClientDetail = None
+        """@ivar: WSDL object that holds client account details."""
         self.response = None
         """@ivar: The response from Fedex. You will want to pick what you
             want out here here. This object does have a __str__() method,
             you'll want to print or log it to see what possible values
             you can pull."""
+        self.TransactionDetail = None
+        """@ivar: Holds customer-specified transaction IDs."""
 
-        self.logger.debug(self.client)
         self.__set_web_authentication_detail()
         self.__set_client_detail()
         self.__set_version_id()
-        self.__set_carrier_code_type(*args, **kwargs)
         self.__set_transaction_detail(*args, **kwargs)
+        self._prepare_wsdl_objects()
 
     def __set_web_authentication_detail(self):
         """
@@ -112,7 +114,6 @@ def __set_web_authentication_detail(self):
         # Encapsulates the auth credentials.
         WebAuthenticationDetail = self.client.factory.create('WebAuthenticationDetail')
         WebAuthenticationDetail.UserCredential = WebAuthenticationCredential
-        self.logger.debug(WebAuthenticationDetail)
         self.WebAuthenticationDetail = WebAuthenticationDetail
 
     def __set_client_detail(self):
@@ -124,7 +125,6 @@ def __set_client_detail(self):
         ClientDetail.AccountNumber = self.config_obj.account_number
         ClientDetail.MeterNumber = self.config_obj.meter_number
         ClientDetail.IntegratorId = self.config_obj.integrator_id
-        self.logger.debug(ClientDetail)
         self.ClientDetail = ClientDetail
 
     def __set_transaction_detail(self, *args, **kwargs):
@@ -133,25 +133,10 @@ def __set_transaction_detail(self, *args, **kwargs):
         """
         customer_transaction_id = kwargs.get('customer_transaction_id', False)
         if customer_transaction_id:
-            TransactionDetail = client.factory.create('TransactionDetail')
+            TransactionDetail = self.client.factory.create('TransactionDetail')
             TransactionDetail.CustomerTransactionId = customer_transaction_id
             self.logger.debug(TransactionDetail)
             self.TransactionDetail = TransactionDetail
-        else:
-            self.TransactionDetail = None
-            
-    def __set_carrier_code_type(self, *args, **kwargs):
-        """
-        Checks kwargs for 'carrier_code' and sets it if present. 
-        """
-        carrier_code = kwargs.get('carrier_code', False)
-        if carrier_code:
-            CarrierCodeType = self.client.factory.create('CarrierCodeType')
-            CarrierCodeType.Type = carrier_code
-            self.logger.debug(CarrierCodeType)
-            self.CarrierCodeType = CarrierCodeType
-        else:
-            self.CarrierCodeType = None
 
     def __set_version_id(self):
         """
@@ -165,6 +150,14 @@ def __set_version_id(self):
         self.logger.debug(VersionId)
         self.VersionId = VersionId
 
+    def __prepare_wsdl_objects(self):
+        """
+        This method should be over-ridden on each sub-class. It instantiates
+        any of the required WSDL objects so the user can just print their
+        __str__() methods and see what they need to fill in.
+        """
+        pass
+        
     def __check_response_for_fedex_error(self):
         """
         This checks the response for general Fedex errors that aren't related