GetShipmentLabels Method

Generates a shipping label using one of domestic UPS services.

Syntax

upsship.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:

• UPSServer (required)
• UPSAccessKey (required)
• UPSPassword (required)
• UPSUserId (required)
• UPSAccountNumber (required)
• ServiceType (required)
• AccountContact (conditional)
• AccountAddress (conditional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• Notify (optional)
• WeightUnit (required; defaults to LB)

Upon successful response, the following properties might be populated:

• MasterTrackingNumber (if MPS)
• PackageTrackingNumber for each package included in the shipment
• PackageShippingLabel for each package included in the shipment
• PackageTotalSurcharges for each package included in the shipment
• TotalNetCharge (applicable to the whole shipment)
• TotalBaseCharge (applicable to the whole shipment)
• TotalSurcharges (applicable to the whole shipment)