Cancel Pickup

Cancel an already scheduled FedEx pickup request. A failure notification will be sent if the courier has already been dispatched.

External Documentation

To learn more, visit the FedEx documentation.

​

Basic Parameters

Parameter	Description
Account Number	The FedEx account number associated with the shipment.
Pickup Confirmation Code	The unique confirmation code provided by FedEx when the pickup was scheduled.
Scheduled Date	The date when the pickup was originally scheduled.

​

Advanced Parameters

Parameter	Description
Additional Parameters	A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters. For example: { “first_key”: 12345, “second_key”: “some_value” } The object must follow the vendor’s structure as defined in the API documentation.
Customer Transaction ID	An ID to assign to the customer transaction.
Language Codes	The language and country code to use in the request.

​

Example Output

{
	"customerTransactionId": "AnyCo_order123456789",
	"output": {
		"alerts": [
			{
				"alertType": "NOTE",
				"code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
				"message": "Recipient Postal-City Mismatch."
			}
		],
		"cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
		"pickupConfirmationCode": "NQAA97"
	},
	"transactionId": "624deea6-b709-470c-8c39-4b5511281492"
}