Create a Pickup
Schedule on-demand carrier pickups directly through the API: no phone calls, no portal logins.
Prerequisites: You'll need an active carrier developer account and a valid access token. See the Carrier Credentials page for setup and auth steps.
Key Request Fields
| Field | Notes |
|---|---|
| associatedAccountNumber.value | Your FedEx account number |
| originDetail.pickupLocation.address | Full pickup address object |
| originDetail.readyDateTimestamp | ISO 8601: when packages are ready |
| originDetail.customerCloseTime | HH:MM:SS: when site closes |
| packageCount | Total number of packages |
| totalWeight | Combined weight object: { units, value } |
| serviceCategory | e.g. FEDEX_GROUND, FEDEX_EXPRESS |
| remarks | Optional pickup instructions |
FedEx Request Example
Reusing your access token: FedEx tokens expire and fetching a new one on every request wastes time and hits rate limits. Use the
get_fedex_token() caching helper from the Carrier Credentials → Token Caching guide, it returns a live token without re-authenticating unless it's about to expire.POST https://apis.fedex.com/pickup/v1/pickups
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
{
"associatedAccountNumber": {
"value": "YOUR_FEDEX_ACCOUNT"
},
"originDetail": {
"pickupLocation": {
"contact": { "personName": "John Doe", "phoneNumber": "3055550100" },
"address": {
"streetLines": ["1234 NW 7th Ave"],
"city": "Miami", "stateOrProvinceCode": "FL",
"postalCode": "33101", "countryCode": "US",
"residential": false
}
},
"readyDateTimestamp": "2026-04-15T14:00:00-05:00",
"customerCloseTime": "17:00:00",
"pickupDateType": "SAME_DAY"
},
"packageCount": 3,
"totalWeight": { "units": "LB", "value": 45.0 },
"serviceCategory": "FEDEX_GROUND",
"remarks": "Packages near loading dock. Ring bell.",
"countryRelationships": "DOMESTIC"
}
// Response includes:
// { "output": { "pickupConfirmationCode": "ABCD1234", ... } }Cut-off times: Same-day pickup requests must be submitted before the carrier's local cut-off (typically 2:00-3:00 PM). Schedule next-day pickups by 5:00 PM the prior business day.
