Download BPOD Files

Request

This API operation is used to download bulk of ERR (Electronic Return Receipt) - POD (Proof of Delivery) files, which are specific to USPS carrier.
User can download BPOD (Bulk Proof of Delivery) files either using Shipment IDs or Date Range.

To get the records based on dates and download BPOD files accordingly, Start Date and End Date need to be passed in the request body as a query filter.
Note: To get a downloadable link of BPOD files on the basis of date range provided, an empty JSON body {} must be passed in the request body.
When both the date range and Shipment IDs are provided in the request, Shipment IDs will take precedance.
User is restricted to download 1000 BPOD files as max limit.

Security

bearerAuth

Query

startDatestring, (date)

The BPOD files to be downloaded from which Date is the startDate in the Date Range filter. This field is not required if the Shipment IDs provided in the request body. Format: YYYY-MM-DD.

Example:startDate=2026-03-12

endDatestring, (date)

The BPOD files to be downloaded till which Date is the endDate in the Date Range filter. This field is not required if the Shipment IDs provided in the request body. Format: YYYY-MM-DD.

Example:endDate=2026-03-12

X-PB-Developer-Partner-IDstring

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required.

Bodyapplication/json

This is the request body to download BPOD files. Request body supports max of 1000 ShipmentIDs in a request.

shipmentIdsArray of strings

This shows the list of Shipment IDs. If this is present, then user does not need to provide Date Range filter. Else startDate and endDate need to be passed in the Query Parameters.

Example:

[
  "USPS09998889999038"
]

curl -i -X POST \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/err/shipments/bpod?startDate=2026-03-12&endDate=2026-03-12' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-ID: string' \
  -d '{
    "shipmentIds": [
      "USPS09998889999038"
    ]
  }'

Responses

The ZIP URL for BPOD files has been created for download.

Bodyapplication/json

fileURLstring

This is the URL for the BPOD (Bulk Proof of Delivery) ZIP file.

Example:"https://api-sandbox.pitneybowes.com/shippingservices/v1/bpod/210000000000000000/bpod-WodOGmplw0W3kR5.zip"

Response

{
  "fileURL": "https://api-sandbox.pitneybowes.com/shippingservices/v1/bpod/210000000000000000/bpod-WodOGmplw0W3kR5.zip"
}