Skip to main content
Create a pickup request for a package or shipment, scheduling a FedEx courier to collect the items from the specified location.
External DocumentationTo learn more, visit the FedEx documentation.

​
Basic Parameters

ParameterDescription
Account NumberThe FedEx account number associated with the shipment.
Carrier CodeThe specific FedEx operating company (carrier) that will handle the pickup and shipment.
Customer Close TimeThe latest time the customer is available for the driver to pick up the package.

Note: Must be in HH:MM:SS format.
Package Ready TimeThe date and time when the shipment or package will be available for the courier to pick up.
Pickup Location - Address CityThe city or town name for the pickup location address.
Pickup Location - Address Country CodeThe two-letter country code associated with the Pickup Location’s address.
Pickup Location - Address Street LinesThe street address of the pickup location, including the street number, name, and any specific suite or delivery details.
Pickup Location - Phone NumberThe phone number of the contact at the pickup location.
Pickup Location - State Or Province CodeThe two-letter country code associated with the Pickup Location’s address.
Pickup Location Address Postal CodeThe postal code of the pickup location.

​
Advanced Parameters

ParameterDescription
Additional ParametersA 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 IDAn ID to assign to the customer transaction.
Language CodesThe 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."
			}
		],
		"location": "COSA",
		"message": "Courier on the way",
		"pickupConfirmationCode": "3001"
	},
	"transactionId": "624deea6-b709-470c-8c39-4b5511281492"
}

​
Workflow Library Example

Create Pickup with Fedex and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop