PackageHub v3 Return Label
For v2 Return Labels click here.
PackageHub v3 allows you to generate a return label using the POST Shipment Return method. An outbound label is required to generate a return label. After an outbound shipping label is created you will receive an "id" and "trackingNumber". Either of these may be used to generate a return label
{
"key":"Id",
"value":"8a3b5dc3-d12c-4c87-808c-59c573bb0b9d"
}
{
"key":"trackingNumber",
"value":"9205590242327000028121"
}
| Field | Outbound | Return without altReturnAddress | Return including altReturnAddress |
| To Address Field | toAddress | fromAddress | altReturnAddress |
| From Address Field | fromAddress | toAddress | toAddress |
PackageHub v2 - Return Label
PackageHub v2 allows you to generate a return label by including the Shipment Option in the POST Create Shipment method.
"ShipmentOptions": [
{
"Name":"RETURN LABEL",
"Value":"true"
}
],
| Field | Outbound | Return without ReturnToAddress | Return including ReturnToAddress |
| Origin Address | ShipToAddress | ShipToAddress | ShipToAddress |
| Destination Address | ShipFromAddress | ShipFromAddress | ShipFromAddress |
An outbound label is not required to generate a return label.