Get Shipment Transaction Report

This Operation returns the report of shipments transactions within the specified date range.

SecuritybearerAuth
Request
query Parameters
startDate
string <date-time>

Start date for the transaction report, in UTC format (e.g., 2025-08-01T00:00:00Z). default start date is today.

endDate
string <date-time>

End date for the transaction report, in UTC format (e.g., 2025-08-15T23:59:59Z). Default end date is today.

size
string

Number of transaction reports per page. Used for pagination.

Example: size=10
page
string

Page number to fetch in paginated results.

Example: page=1
carrier
string

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

Example: carrier=UPS
insurance
boolean

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

Example: insurance=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
header Parameters
X-PB-Developer-Partner-ID
string

This is the Developer Partner ID.

Responses
200

Successfully retrived the Shipments Transaction Report.

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
{
  • "data": [
    ],
  • "pageInfo": {
    }
}