More commenting and details in the create_shipment.py example.

Author: Greg Taylor

examples/create_shipment.py

@@ -19,91 +19,99 @@
                          use_test_server=True)
 
 # This is the object that will be handling our tracking request.
-ship = FedexProcessShipmentRequest(config_obj)
+shipment = FedexProcessShipmentRequest(config_obj)
 
 # This is very generalized, top-level information.
 # REGULAR_PICKUP, REQUEST_COURIER, DROP_BOX, BUSINESS_SERVICE_CENTER or STATION
-ship.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
+shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
 
 # See page 355 in WS_ShipService.pdf for a full list. Here are the common ones:
 # STANDARD_OVERNIGHT, PRIORITY_OVERNIGHT, FEDEX_GROUND, FEDEX_EXPRESS_SAVER
-ship.RequestedShipment.ServiceType = 'PRIORITY_OVERNIGHT'
+shipment.RequestedShipment.ServiceType = 'PRIORITY_OVERNIGHT'
 
 # What kind of package this will be shipped in.
 # FEDEX_BOX, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING
-ship.RequestedShipment.PackagingType = 'FEDEX_PAK'
+shipment.RequestedShipment.PackagingType = 'FEDEX_PAK'
 
 # No idea what this is.
 # INDIVIDUAL_PACKAGES, PACKAGE_GROUPS, PACKAGE_SUMMARY 
-ship.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
+shipment.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
 
 # Shipper contact info.
-ship.ShipperContact.PersonName = 'Sender Name'
-ship.ShipperContact.CompanyName = 'Some Company'
-ship.ShipperContact.PhoneNumber = '9012638716'
+shipment.ShipperContact.PersonName = 'Sender Name'
+shipment.ShipperContact.CompanyName = 'Some Company'
+shipment.ShipperContact.PhoneNumber = '9012638716'
 
 # Shipper address.
-ship.ShipperAddress.StreetLines = ['Address Line 1']
-ship.ShipperAddress.City = 'Herndon'
-ship.ShipperAddress.StateOrProvinceCode = 'VA'
-ship.ShipperAddress.PostalCode = '20171'
-ship.ShipperAddress.CountryCode = 'US'
-ship.ShipperAddress.Residential = True
+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
 
 # Recipient contact info.
-ship.RecipientContact.PersonName = 'Recipient Name'
-ship.RecipientContact.CompanyName = 'Recipient Company'
-ship.RecipientContact.PhoneNumber = '9012637906'
+shipment.RecipientContact.PersonName = 'Recipient Name'
+shipment.RecipientContact.CompanyName = 'Recipient Company'
+shipment.RecipientContact.PhoneNumber = '9012637906'
 
 # Recipient address
-ship.RecipientAddress.StreetLines = ['Address Line 1']
-ship.RecipientAddress.City = 'Herndon'
-ship.RecipientAddress.StateOrProvinceCode = 'VA'
-ship.RecipientAddress.PostalCode = '20171'
-ship.RecipientAddress.CountryCode = 'US'
+shipment.RecipientAddress.StreetLines = ['Address Line 1']
+shipment.RecipientAddress.City = 'Herndon'
+shipment.RecipientAddress.StateOrProvinceCode = 'VA'
+shipment.RecipientAddress.PostalCode = '20171'
+shipment.RecipientAddress.CountryCode = 'US'
 # This is needed to ensure an accurate rate quote with the response.
-ship.RecipientAddress.Residential = True
+shipment.RecipientAddress.Residential = True
 
 # RECIPIENT, SENDER or THIRD_PARTY
-ship.ShippingChargesPayment.PaymentType = 'SENDER' 
+shipment.ShippingChargesPayment.PaymentType = 'SENDER' 
 
 # These are example label values. You'll want to adjust these to fit your
 # usage case.
-ship.LabelSpecification.LabelFormatType = 'COMMON2D'
-ship.LabelSpecification.ImageType = 'PNG'
-ship.LabelSpecification.LabelStockType = 'PAPER_7X4.75'
+shipment.LabelSpecification.LabelFormatType = 'COMMON2D'
+shipment.LabelSpecification.ImageType = 'PNG'
+shipment.LabelSpecification.LabelStockType = 'PAPER_7X4.75'
 
-package1_weight = ship.create_wsdl_object_of_type('Weight')
+package1_weight = shipment.create_wsdl_object_of_type('Weight')
 # Weight, in pounds.
 package1_weight.Value = 1.0
 package1_weight.Units = "LB"
 
-package1 = ship.create_wsdl_object_of_type('RequestedPackageLineItem')
+package1 = shipment.create_wsdl_object_of_type('RequestedPackageLineItem')
 package1.Weight = package1_weight
 #print package1
 
-ship.add_package(package1)
+shipment.add_package(package1)
 
 # If you'd like to see some documentation on the ship service WSDL, un-comment
 # this line. (Spammy).
-#print ship.client
+#print shipment.client
 
 # Un-comment this to see your complete, ready-to-send request as it stands
 # before it is actually sent. This is useful for seeing what values you can
 # change.
-#print ship.RequestedShipment
+#print shipment.RequestedShipment
 
 # Fires off the request, sets the 'response' attribute on the object.
-ship.send_request()
+shipment.send_request()
 
 # This will show the reply to your shipment being sent. You can access the
-# attributes through the response attribute on the request object.
-print ship.response
+# 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
+
+# Here is the overall end result of the query.
+print "HighestSeverity:", shipment.response.HighestSeverity
+# Getting the tracking number from the new shipment.
+print "Tracking #:", shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber
+# Net shipping costs.
+print "Net Shipping Cost (US$):", shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].PackageRating.PackageRateDetails[0].NetCharge.Amount
 
 # Get the label image in ASCII format from the reply. Note the list indices
 # we're using. You'll need to adjust or iterate through these if your shipment
 # has multiple packages.
-ascii_label_data = ship.response.CompletedShipmentDetail.CompletedPackageDetails[0].Label.Parts[0].Image
+ascii_label_data = shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].Label.Parts[0].Image
 # Convert the ASCII data to binary.
 label_binary_data = binascii.a2b_base64(ascii_label_data)