Get Pickup Document

Request

The API retrieves the document for a scheduled pickup receipt using the pickupId, generated when the pickup is successfully scheduled.

Security

bearerAuth

Path

pickupIdstringrequired

Unique identifier for the scheduled pickup.

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/{pickupId}/document' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string'

Responses

Pick up document have been fetched.

Headers

X-PB-TransactionIdstring

A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.

Bodyapplication/json

pickupIdstring

Unique ID of the scheduled pickup.

Example:"USPSRL7VG8U2WMEC"

urlstring

The URL for accessing the generated PDF document.

Example:"https://22593******-sending-service-**.s3-fips.us-east-1.amazonaws.com/scheduled-pickup/USPSRL7VG8U2WMEC.pdf"

Response

{
  "pickupId": "USPSRL7VG8U2WMEC",
  "url": "https://22593******-sending-service-**.s3-fips.us-east-1.amazonaws.com/scheduled-pickup/USPSRL7VG8U2WMEC.pdf"
}