Get All Shipments

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.

SecuritybearerAuth
Request
query Parameters
startDate
string

While searching shipments, user set a date range to get all created shipments. This indicatesthe start date of the set date range under shipment search criteria. The date format must be: YYYY-MM-DD.

endDate
string

While searching shipments, user set a date range to get all created shipments. This indicatesthe end date of the set date range under shipment search criteria. The date format must be: YYYY-MM-DD.

page
string

The page of the Shipments search result list.

size
string

The size/count of the searched result list.

carrier
string

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

Example: carrier=UPS
insured
boolean

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

Example: insured=true
returnLabel
boolean

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

Example: returnLabel=false
isInternational
boolean

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

Example: isInternational=true
refundEligible
boolean

Filter shipments eligible for refund.

Example: refundEligible=true
merchant
boolean

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
shipmentType
string

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
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.

X-PB-LocationId
string
  • Specifies the Location ID associated with the shipment.
  • When provided, the response is filtered based on the specified Location ID.
Responses
200

List of shipments.

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/shipments
Request samples 
Response samples 
application/json
{
  • "pageInfo": {
    },
  • "data": [
    ]
}