DHL Return Label

Generates a DHL return label for a parcel and returns it so it can be sent to the customer. Use it during a returns flow to give the customer a ready return label.

What it does

  • Creates a return shipment through the DHL returns service for the given shipper address.
  • Returns the label (as base64), the shipment number and the routing code.
  • Reports a clear failure message when DHL does not return a label.

Inputs

NameTypeDescription
App IDStringDHL app id
App KeysensitiveStringDHL app key
Business Portal UsernameStringDHL business portal username
Business Portal PasswordsensitiveStringDHL business portal password
Receiver IDStringDHL retour receiver id
Reference NumberStringReference Number
Shipper NameStringShipper Name
Shipper StreetStringShipper Street
Shipper House NoStringShipper House No
Shipper Post CodeStringShipper Post Code
Shipper CityStringShipper City
Shipper Country CodeStringShipper Country Code
WeightNumberParcel weight in grams

Outputs

NameTypeDescription
SuccessBooleanWhether label successfully generated
LabelStringLabel in base64
Shipment NumberStringShipment number
Routing CodeStringRouting Code

Notes

  • Requires DHL business portal credentials (app ID, app key, username and password) and a DHL receiver ID for returns.
  • Parcel weight is given in grams.