Skip to content
Shipping APIs
/
/
Schedule Pickup

Schedule Pickup

Request

Pickups endpoint allows you to schedule pickups with USPS, DHL Express, UPS and FedEx carriers for eligible shipments. The pickup schedule scope is determined by what you provide in the request:

  • If pickupSummary is provided: a pickup is scheduled for the packages described in the summary.
  • If shipmentIds are provided: a pickup is scheduled for the specified shipments.
  • If both pickupSummary and shipmentIds are provided: a pickup is scheduled for all shipments including by both inputs.
  • If neither is provided: a pickup is scheduled for all shipments created on the given carrier account by that time of the day.
  • carrierAccountId handling: carrierAccountId is required to schedule a pickup. Either provide carrierAccountId in the request payload, or provide X-PB-LocationId with a location that has only one carrier account configured for the selected carrier.

Note: The sender's first name and last name are required for USPS. For example: "name": "John Doe"

Security
bearerAuth
Headers
X-PB-Developer-Partner-Idstring

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

X-PB-LocationIdstring

The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed. If this header is not provided, the system automatically uses the enterprise-level location that was created during developer account onboarding. This default location is then used for shipment processing, carrier selection, and billing.

Selection Rules

  • If X-PB-LocationId is provided and the location has one carrier with one account:

    • carrier is optional
    • carrierAccountId is optional
    • The available carrier account is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has one carrier with one account:

    • carrier is optional
    • carrierAccountId is optional
    • The available carrier account is selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has one carrier with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has one carrier with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has multiple carriers with one account each:

    • carrier is required
    • carrierAccountId is optional
    • The specified carrier and its associated account are selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has multiple carriers with one account each:

    • carrier is required
    • carrierAccountId is optional
    • The specified carrier and its associated account are selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has multiple carriers with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has multiple carriers with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.
Bodyapplication/jsonrequired
One of:
packageLocationstringrequired

The location where the parcel will be available for pickup at the specified pickup address.

Enum:"Front""Back""Reception""Loading Dock"
Example:"None"
carrierAccountIdstring

The unique identifier of the carrier account being used to process the pickup.

Example:"X4pqLKjQ5XX"
pickupAddressobjectrequired
Example:
{
  "name": "Test",
  "addressLine1": "27 Waterview Dr",
  "cityTown": "Shelton",
  "stateProvince": "CT",
  "postalCode": "06484-4301",
  "countryCode": "US",
  "phone": "1234567890",
  "company": "PB",
  "email": "ankita.chaurasia@pb.com"
}
pickupSummaryArray of objects

An array of the pickup details, including the number of packages, total weight, and carrier service information and package details.

Example:
[
  {
    "serviceId": "NDA",
    "packageCount": 1,
    "totalWeight": 15,
    "weightUnit": "OZ",
    "packageDetails": [
      { … }
    ],
    "currencyCode": "USD",
    "totalCustomsDeclaredValue": 5
  }
]
additionalnotesstring

Additional instructions or notes for the carrier regarding the pickup.

Example:"Call before pickup"
referencestring

An optional Reference related to the pickup.

Example:"zscsdc"
shipmentIdsArray of strings

List of shipment IDs for which pickup needs to be scheduled.

Example:
[
  "DHLEXP2201736600235437",
  "DHLEXP2201736600264906"
]
pickupOptionsobjectrequired
Example:
{
  "pickupStartDateTime": "2025-09-29T09:05:05Z",
  "pickupEndDateTime": "2025-09-29T18:30:00Z",
  "carrierType": "EXPRESS",
  "overweight": 2
}
curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/pickups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string' \
  -d '{
    "packageLocation": "Reception",
    "carrierAccountId": "wgjYXvYjD0V4",
    "pickupAddress": {
      "name": "Test",
      "addressLine1": "27 Waterview Dr",
      "cityTown": "Shelton",
      "stateProvince": "CT",
      "postalCode": "06484-4301",
      "countryCode": "US",
      "phone": "1234567890",
      "company": "PB",
      "email": "ankita.chaurasia@pb.com"
    },
    "pickupSummary": [
      {
        "serviceId": "NDA",
        "packageCount": 1,
        "totalWeight": 15,
        "weightUnit": "OZ",
        "packageDetails": [
          {
            "width": 1,
            "height": 15,
            "length": 10,
            "dimUnit": "IN",
            "weightUnit": "OZ",
            "weight": 15
          }
        ],
        "currencyCode": "USD",
        "totalCustomsDeclaredValue": 5
      }
    ],
    "shipmentIds": [
      "DHLEXP2201736600235437",
      "DHLEXP2201736600264906"
    ],
    "pickupOptions": {
      "pickupStartDateTime": "2025-09-29T09:05:05Z",
      "pickupEndDateTime": "2025-09-29T18:30:00Z",
      "carrierType": "EXPRESS",
      "overweight": 2
    },
    "reference": "reference"
  }'

Responses

The Pickup has been created successfully.

Bodyapplication/json
One of:
packageLocationstring

The location where the parcel will be available for pickup at the specified pickup address.

Enum:"Front""Back""Reception""Loading Dock"
Example:"None"
pickupConfirmationNumberstring

The confirmation number generated when the pickup request is successfully processed.

Example:"CAME241011000909"
pickupIdstring

A unique identifier for the scheduled pickup.

Example:"DHLEXP10111728640015873"
carrierstring

The carrier being used for the pickup.

Example:"dhlexp"
carrierAccountIdstring

The unique identifier of the carrier account being used to process the pickup.

Example:"j4pqLKjQ5dn"
pickupAddressobject
Example:
{
  "addressLine1": "27 Waterview Dr",
  "cityTown": "Shelton",
  "company": "PB",
  "countryCode": "US",
  "email": "ankita.chaurasia@pb.com",
  "name": "Test",
  "phone": "1234567890",
  "postalCode": "06484-4301",
  "residential": false,
  "stateProvince": "CT"
}
pickupSummaryArray of objects

An array of the pickup details, including the number of packages, total weight, and carrier service information.

Example:
[
  {
    "serviceId": "NDA",
    "packageCount": 1,
    "totalWeight": 15,
    "weightUnit": "OZ",
    "totalCustomsDeclaredValue": 5,
    "currencyCode": "USD"
  },
  {
    "serviceId": "NDA",
    "packageCount": 2,
    "totalWeight": 20,
    "weightUnit": "OZ"
  }
]
additionalNotesstring

Additional instructions or notes for the carrier regarding the pickup.

Example:"absdhda"
pickupDateTimestring

The sdate and time of the pickup window.

Example:"2024-10-10T17:05:05Z"
pickupTotalWeightnumber

The total weight of all packages being picked up.

Example:16
pickupTotalWeightUnitstring

The unit of measurement for the total package weight.

Example:"OZ"
referencestring

An optional Reference related to the pickup.

Example:"zscsdc"
pickupOptionsobject
Example:
{
  "pickupStartDateTime": "2025-09-29T09:05:05Z",
  "pickupEndDateTime": "2025-09-29T18:30:00Z",
  "overweight": 2,
  "carrierType": "EXPRESS"
}
Response
{
  "carrierAccountId": "wgjYXvYjD0V4",
  "carrier": "dhlexp",
  "pickupAddress": {
    "addressLine1": "27 Waterview Dr",
    "cityTown": "Shelton",
    "company": "PB",
    "countryCode": "US",
    "email": "ankita.chaurasia@pb.com",
    "name": "Test",
    "phone": "1234567890",
    "postalCode": "06484-4301",
    "residential": false,
    "stateProvince": "CT"
  },
  "packageLocation": "RECEPTION",
  "shipmentIds": [
    "DHLEXP2201736600235437",
    "DHLEXP2201736600264906"
  ],
  "pickupSummary": [
    {
      "serviceId": "NDA",
      "packageCount": 1,
      "totalWeight": 15,
      "weightUnit": "OZ",
      "totalCustomsDeclaredValue": 5,
      "currencyCode": "USD"
    },
    {
      "serviceId": "NDA",
      "packageCount": 2,
      "totalWeight": 20,
      "weightUnit": "OZ"
    }
  ],
  "reference": "reference",
  "pickupDateTime": "2025-09-29T09:05:00Z",
  "pickupConfirmationNumber": "AME250929000197",
  "pickupId": "DHLEXP09261758885311045",
  "pickupOptions": {
    "pickupStartDateTime": "2025-09-29T09:05:05Z",
    "pickupEndDateTime": "2025-09-29T18:30:00Z",
    "overweight": 2,
    "carrierType": "EXPRESS"
  },
  "pickupTotalWeight": 35,
  "pickupTotalWeightUnit": "OZ"
}