Parcel Protection Reports

HTTP Request

GET /v1/developers/{developerId}/parcel-protection/reports

Summary

This operation retrieves data related to the Parcel Protection policies created for the shipments you specify.

Path Parameter

Name Description
developerId
Required. Your Pitney Bowes developer ID.

Query Parameters

Query parameters are optional.

Name Description
policyCreatedFromDate The beginning of the date range. Specify this value in UTC using the ISO 8601 Date Format. You must include both date and time, and you must end the time with Z to indicate a zero offset.
policyCreatedToDate

The end of the date range. Specify this value in UTC using the ISO 8601 Date Format. You must include both date and time, and you must end the time with Z to indicate a zero offset. For example:

toDate=2018-01-02T23:59:00Z

policyReferenceId The policy’s reference ID
parcelTrackingNumber The shipment’s parcel tracking number.
merchantId The merchant’s shipper ID. The shipper ID is value of the postalReportingNumber element in the Merchant Object.
policyStatus Whether the policy is active or voided
size

The number of transactions to return per page in the result set.

Default: 20

page The index number of the page to return. Page index numbering starts at 0. Specifying page=0 returns the first page of the result set.
sort

Defines a property to sort on and the sort order. Sort order can be ascending (asc) or descending (desc). Use the following form:

sort=<property_name>,<sort_direction>

For example:

sort=policyDate,desc

Request Headers

Name
Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
X-PB-TransactionId

A unique identifier for the transaction, up to 25 characters.

Important: You must ensure this is a unique id.

X-PB-UnifiedErrorStructure Recommended. Set this to true to use the standard error object if an error occurs.

Response Elements

Name Data Type Description
content Array[Object] The parcel protection policies. Each object in the array is a separate policy/transaction.
totalPages Number Total Number of pages in the result set.
totalElements Number Total number of transactions in the result set.
last Boolean If true, this is the last page of the result set.
first Boolean If true, this is the first page of the result set.
numberOfElements Number The number of transactions in the current page.
sort Array[Object] The property used to sort the transactions and the sort order.
size Number The number of transactions per page in the result set. The default size is 20.
number Number The index number of the page being returned. Page index numbering starts at 0. If number is set to 4, this is the 5th page of the result set.