Skip to content
Shipping APIs
/
/
Get Pickups

Get Pickups

Request

Get Pickups

Security
bearerAuth
Query
carrierstring

Name of the carrier to retrieve pickups for.

startDatestring

The start date for filtering pickups. Format: YYYY-MM-DD.

endDatestring

The end date for filtering pickups. Format: YYYY-MM-DD.

statusstring

The status of the pickups to retrieve (scheduled or cancelled).

Headers
X-PB-Developer-Partner-Idstring

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

curl -i -X GET \
  'https://api-dev.sendpro360.pitneycloud.com/shipping/api/v1/pickups?carrier=string&startDate=string&endDate=string&status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string'

Responses

List of pickups.

Bodyapplication/json
pageInfoobject
dataobject
Response
{
  "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": [
      { … }
    ],
    "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"
    }
  }
}