Get All Shipments

Request

The operation fetches all created Shipments. If query parameters are not provided, it will default endDate as current date, page as 1 and size as 10.

Security

bearerAuth

Query

startDatestring

The start date of the date range used to filter shipments by their transaction creation date (the date the shipment record was created in the system). The date format must be: YYYY-MM-DD.

Example:startDate=2026-06-01

endDatestring

The end date of the date range used to filter shipments by their transaction creation date (the date the shipment record was created in the system). The date format must be: YYYY-MM-DD.

Example:endDate=2026-06-10

pagestring

The page of the Shipments search result list.

sizestring

The size/count of the searched result list.

carrierstring

Filter shipments transaction report by carrier code (e.g., UPS, FEDEX, USPS).

Example:carrier=UPS

insuredboolean

Filter shipments by insurance status. Set to true for insured shipments, false otherwise.

Example:insured=true

returnLabelboolean

Filter shipments that include return labels. Set to true to return only shipments with return labels, false otherwise.

Example:returnLabel=false

isInternationalboolean

Filter shipments by type. Set true for international shipments, false for domestic shipments.

Example:isInternational=true

refundEligibleboolean

Filter shipments eligible for refund.

Example:refundEligible=true

merchantboolean

Filter merchant shipments transaction report.

true → Returns shipment transaction reports for all merchants associated with the developer.
To view the transaction report for a specific merchant, include the header X-PB-Developer-Partner-ID with the value set to that merchant's subscriptionId.

Example:merchant=true

shipmentTypestring

Filter by shipment type. Accepted values:

multipiece: multi-piece shipments
apv: Adjusted Postage Value (APV) shipments If omitted, all shipment types are returned.

Example:shipmentType=apv

fromShipmentDatestring

The start date of the date range used to filter shipments by their dateOfShipment (the actual ship date set on the shipment). Only shipments that have a dateOfShipment value are returned when this filter is applied. The date format must be: YYYY-MM-DD.

Example:fromShipmentDate=2026-06-01

toShipmentDatestring

The end date of the date range used to filter shipments by their dateOfShipment (the actual ship date set on the shipment). Only shipments that have a dateOfShipment value are returned when this filter is applied. The date format must be: YYYY-MM-DD.

Example:toShipmentDate=2026-06-10

X-PB-Developer-Partner-Idstring

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

X-PB-LocationIdstring

Specifies the Location ID associated with the shipment.
When provided, the response is filtered based on the specified Location ID.

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shipments?startDate=2026-06-01&endDate=2026-06-10&page=string&size=string&carrier=UPS&insured=true&returnLabel=false&isInternational=true&refundEligible=true&merchant=true&shipmentType=apv&fromShipmentDate=2026-06-01&toShipmentDate=2026-06-10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string'

Responses

List of shipments.

Bodyapplication/json

One of:

pageInfoobject

dataArray of objects

Response

{
  "pageInfo": {
    "total": 78,
    "pages": 8,
    "page": 1
  },
  "data": [
    {
      "correlationId": "49ce304a251447539c84b204d968d7c4",
      "subId": "sac735d",
      "fromAddress": { … },
      "toAddress": { … },
      "altReturnAddress": { … },
      "parcelTrackingNumber": "UPS2202625646462636",
      "serviceId": "NDA",
      "rates": [ … ],
      "shipmentId": "UPS2202625646462636",
      "shipmentOptions": { … },
      "customs": { … },
      "status": "Label Printed",
      "carrier": "ups",
      "carrierAccountId": "EQ7Ar2dmXXX",
      "metadata": [ … ],
      "parcel": { … },
      "dispenseClient": "api",
      "refundStatus": "string",
      "isInternational": true,
      "isReturnLblRequested": false,
      "insured": true,
      "carrierCode": "string",
      "transactionCreateDate": "2026-02-09T07:22:05.457Z",
      "locationId": "zLwdWnZ7LyVWknO",
      "customerLocationId": "zLwdWnZ7LyVWknO",
      "references": { … },
      "ecommerceProvider": { … }
    }
  ]
}