Check Pickup Availability

Request

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.

Security

bearerAuth

Accept-Languagestring^[a-z]{2}-[A-Z]{2}$required

Locale for response messages, BCP-47 format (language-region), e.g., en-US.

Example:en-US

Bodyapplication/jsonrequired

carrierAccountIdstringrequired

Unique identifier of the carrier account under which pickup is requested.

Example:"GkvvOE7vX1QxQkm"

pickupAddressobjectrequired

Address where pickup is requested.

Example:

{
  "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
}

pickupSummaryArray of objectsrequired

Summary of shipments for which pickup is requested.

Example:

[
  {
    "toAddressCountryCode": "CA",
    "serviceId": "",
    "parcelType": "PKG",
    "packageDetails": [
      { … }
    ]
  }
]

pickupDateTimestring, (date-time)required

Requested pickup date and time in ISO 8601 format.

Example:"2025-08-25T17:05:05Z"

pickupOptionsobjectrequired

Additional options for pickup eligibility.

Example:

{
  "pickupStartDateTime": "2025-09-15T12:45:00Z",
  "pickupEndDateTime": "2025-09-15T13:15:00Z",
  "carrierType": "EXPRESS",
  "scheduleDay": "SAME_DAY"
}

curl -i -X POST \
  https://api-dev.sendpro360.pitneycloud.com/shipping/api/v1/pickups/availability \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
    }
  }'

Responses

Pickup availability details returned successfully.

Bodyapplication/json

carrierAccountIdstring

Carrier account ID returned for the request.

Example:"xxxxxxxxx"

carrierstring

Carrier that was validated for pickup availability.

Example:"UPS"

pickupAddressobject

Validated pickup address returned by the carrier/system.

Example:

{
  "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"
}

pickupDateTimestring, (date-time)

The pickup date/time

Example:"2025-08-26T10:00:00Z"

pickupOptionsobject

Additional options for pickup eligibility.

Example:

{
  "pickupStartDateTime": "2025-09-15T12:45:00Z",
  "pickupEndDateTime": "2025-09-15T13:15:00Z",
  "carrierType": "EXPRESS",
  "scheduleDay": "SAME_DAY"
}

pickupAvailableboolean

If pickup is available for the requested location and shipment..

Example:true

pickupInformationobject

Detailed pickup availability options as returned by the requested carrier.

Example:

{
  "cutoffTime": "16:15:00",
  "startCloseTimeOptions": {
    "startTimeOptions": [
      "12:30:00",
      "13:00:00"
    ],
    "closeTimeOptions": [
      "12:30:00",
      "13:00:00",
      "13:30:00"
    ]
  },
  "timeRangeOptions": {}
}

Response

{
  "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": [ … ],
      "closeTimeOptions": [ … ]
    },
    "timeRangeOptions": {}
  }
}