Schedule Pickup

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 is 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.

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

SecuritybearerAuth

Request

header Parameters

X-PB-Developer-Partner-Id

string

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

Request Body schema: application/json

One of:

packageLocation required	string The location where the parcel will be available for pickup at the specified pickup address. Enum: "Front" "Back" "Front" "Reception" "Loading Dock"
carrierAccountId required	string The unique identifier of the carrier account being used to process the pickup.
required	object
	Array of objects An array of the pickup details, including the number of packages, total weight, and carrier service information and package details.
additionalnotes	string Additional instructions or notes for the carrier regarding the pickup.
reference	string An optional Reference related to the pickup.
shipmentIds	Array of strings List of shipment IDs for which pickup needs to be scheduled.
required	object

Responses

200

The Pickup has been created 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

Request samples

application/json

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

Response samples

application/json

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