GetShipmentLabels Method
Generates a shipping label.
Syntax
void __fastcall GetShipmentLabels();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)
- SoldToContact (conditional)
- SoldToAddress (conditional)
- Payor (required)
- ShipmentSpecialServices (optional)
- ShipmentDescription (conditional)
- ShipmentReference (conditional)
- Packages (required)
- LabelImageType (required)
- Notify (optional)
- FormTypes (optional)
- CommercialInvoice (optional)
- Commodities (conditional)
- CODReportFile (optional)
- CODTotalAmount (optional)
- CODType (optional)
- WeightUnit (required; defaults to LB)
- Documents (optional)
The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).
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 (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
- TotalNetCharge (applicable to the whole shipment);
- TotalBaseCharge (applicable to the whole shipment);
- TotalSurcharges (applicable to the whole shipment);