CancelPackage Method
Cancels a single package shipment by deleting it from the shipping log.
Object Oriented Interface
public function doCancelPackage($trackingnumber, $trackingidtype);
Procedural Interface
inship_fedexship_do_cancelpackage($res, $trackingnumber, $trackingidtype);
Remarks
To cancel a single package shipment, a delete shipment request should be sent to the FedEx FedExServer. This can be done by calling CancelPackage method.
The TrackingNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the PackageTrackingNumber assigned to the package by FedEx server when either the GetPackageLabel or the GetShipmentLabels method was called.
The TrackingIdType parameter identifies the service that was used to ship the package. Possible values are:
| Value | Id Type |
| 0 (default) | FedEx Express |
| 1 | FedEx Ground |
| 2 | USPS |
The following properties can be set prior to calling this method:
- FedExServer (required)
- FedExDeveloperKey (required)
- FedExPassword (required)
- FedExAccountNumber (required)
- FedExMeterNumber (required)
- ShipDate (optional)
- ShipTime; (optional)
These should be the values associated with the designated package to be canceled (i.e., the values used when this shipping request was made).
If you are unable to delete the package, you will receive an error condition. This error condition means that:
- For Ground shipments, a close has already been performed for that TrackingNumber.
- For Express shipments, the package has already been tendered to FedEx.
- You have entered an invalid FedExAccountNumber or FedExMeterNumber.
- The FedExAccountNumber and FedExMeterNumber, while valid, are not associated with one another or with the TrackingNumber.
- You entered an invalid TrackingNumber. This applies to Ground shipments only. Express accepts any number with the correct amount of digits.