Schedule Pickup

Pickups endpoint allows you to schedule pickups with USPS, DHL Express, UPS and FedEx carriers for eligible shipments that you have already created.

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

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": "None",
  • "carrierAccountId": "X4pqLKjQ5XX",
  • "pickupAddress": {
    },
  • "pickupSummary": [
    ],
  • "additionalnotes": "Call before pickup",
  • "reference": "zscsdc",
  • "pickupOptions": {
    }
}
Response samples
application/json
{
  • "packageLocation": "None",
  • "pickupConfirmationNumber": "CAME241011000909",
  • "pickupId": "DHLEXP10111728640015873",
  • "carrier": "dhlexp",
  • "carrierAccountId": "j4pqLKjQ5dn",
  • "pickupAddress": {
    },
  • "pickupSummary": [
    ],
  • "additionalNotes": "absdhda",
  • "pickupDateTime": "2024-10-10T17:05:05Z",
  • "pickupTotalWeight": 16,
  • "pickupTotalWeightUnit": "OZ",
  • "reference": "zscsdc",
  • "pickupOptions": {
    }
}