Check Pickup Availability

Validates if the requested carrier can perform a pickup at the provided address, given the shipment details and requested pickup date/time.

The response also indicates:

If pickup is available at the location.
What types of pickup (residential, on-demand, scheduled) are supported.
Cutoff times and valid pickup time windows.

SecuritybearerAuth

Request

Request Body schema: application/json

carrierAccountId required	string Unique identifier of the carrier account under which pickup is requested.
required	object Address where pickup is requested.
required	Array of objects Summary of shipments for which pickup is requested.
pickupDateTime required	string <date-time> Requested pickup date and time in ISO 8601 format.
required	object Additional options for pickup eligibility.

Responses

200

Pickup availability details returned successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/pickups/availability

Request samples

application/json

{"carrierAccountId": "97wroboxVgbzK4N",
"pickupAddress": {"name": "Test",
"addressLine1": "27 Waterview Dr",
"cityTown": "Shelton",
"stateProvince": "CT",
"postalCode": "06484-4301",
"countryCode": "US",
"phone": "1234567890",
"company": "PB",
"email": "abc@test.com",
"residential": false
},
"pickupSummary": [{"toAddressCountryCode": "CA",
"serviceId": "",
"parcelType": "PKG",
"packageDetails": [{"height": 5,
"length": 6,
"width": 4,
"dimUnit": "IN",
"weight": 34,
"weightUnit": "OZ"
}
]
}
],
"pickupDateTime": "2025-09-15T13:00:00Z",
"pickupOptions": {"pickupStartDateTime": "2025-09-15T12:45:00Z",
"pickupEndDateTime": "2025-09-15T13:15:00Z",
"carrierType": "EXPRESS",
"scheduleDay": "SAME_DAY"
}
}

Response samples

application/json

{"carrierAccountId": "97wroboxVgbzK4N",
"carrier": "fedex",
"pickupAddress": {"addressLine1": "27 Waterview Dr",
"cityTown": "Shelton",
"company": "PB",
"countryCode": "US",
"email": "abc@test.com",
"name": "Test",
"phone": "1234567890",
"postalCode": "06484-4301",
"residential": false,
"stateProvince": "CT"
},
"pickupDateTime": "2025-09-15T13:00:00Z",
"pickupOptions": {"pickupStartDateTime": "2025-09-15T12:45:00Z",
"pickupEndDateTime": "2025-09-15T13:15:00Z",
"carrierType": "EXPRESS",
"scheduleDay": "SAME_DAY"
},
"pickupAvailable": true,
"pickupInformation": {"cutoffTime": "16:15:00",
"startCloseTimeOptions": {"startTimeOptions": ["12:30:00",
"13:00:00"
],
"closeTimeOptions": ["12:30:00",
"13:00:00",
"13:30:00"
]
},
"timeRangeOptions": { }
}
}