Get Pickups

SecuritybearerAuth

Request

query Parameters

carrier required	string Name of the carrier to retrieve pickups for.
startDate required	string The start date for filtering pickups. Format: YYYY-MM-DD.
endDate required	string The end date for filtering pickups. Format: YYYY-MM-DD.
status required	string The status of the pickups to retrieve (scheduled or cancelled).

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.

Responses

200

List of pickups.

400

Invalid request.

401

The request could not be authorized.

500

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

get/api/v1/pickups

Request samples

Response samples

application/json

{"pageInfo": {"total": 78,
"pages": 8,
"page": 1
},
"data": {"packageLocation": "None",
"confirmationNumber": "2929602E9CP",
"pickupId": "UPS10191697701340901",
"carrier": "ups",
"carrierAccountId": "j4pqLKjQ5dn",
"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": 2,
"totalWeight": 15,
"weightUnit": "OZ",
"currencyCode": "USD",
"parcelType": "PKG",
"packageDetails": [{"width": 1,
"height": 15,
"length": 10,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 1
}
]
}
],
"specialInstructions": "Call befor pickup",
"totalWeight": 16,
"pickupTotalWeightUnit": "OZ",
"totalCount": 2,
"status": "scheduled",
"reference": "zscsdc",
"pickupDateTime": "2024-10-10T17:05:05Z",
"pickupOptions": {"pickupStartDateTime": "2024-10-10T17:03:05Z",
"pickupEndDateTime": "2024-10-10T17:05:05Z"
}
}
}