GetShipmentLabels Method

Generates a shipping label for all packages in the shipment.

Syntax

fedexship.getShipmentLabels([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

When this method is called, the following properties must have been set:

• FedExServer (required)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExAccountNumber (required)
• FedExMeterNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackageType (required)
• DropoffType (optional)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

When shipping via FedEx Ground then the PackageType should be set to ptYourPackaging.

This method fills in the following properties:

• PackageTrackingNumber for each package included in the shipment;
• PackageShippingLabel for each package included in the shipment;
• PackageNetCharge for each package included in the shipment;
• PackageBaseCharge for each package included in the shipment;
• PackageTotalDiscount for each package included in the shipment;
• PackageTotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);