Transaction Reports

HTTP Request

GET /v4/ledger/developers/{developerId}/transactions/reports

Previous version: v2

Summary

This operation retrieves transaction history according to the parameters you specify. If you don’t specify parameters, the API returns all transactions for the 31 days prior to the current date.

Things to Consider

  1. The report returns the following transaction types within the following time frames:

    Transaction Type
    Description
    The transaction appears in the transaction report:
    POSTAGE FUND The funding of the postage account Within 1 hour.
    POSTAGE PRINT The printing of a label Within 1 hour.
    POSTAGE REFUND A refund request or the resolution of a refund request
    • Within 1 hour for a refund-request transaction.
    • The same day as notification from USPS for a refund-resolution transaction.
    FEE An ACH return fee. The status field indicates whether the fee is processed or waived. Within 24 hours.
    APV-POSTAGE OVERPAID An APV adjustment for an overpayment Within 24 hours of notification from USPS.
    APV-POSTAGE UNDERPAID An APV adjustment for an underpayment Within 24 hours of notification from USPS.
    APV-DISPUTE ADJUSTMENT A dispute of an APV adjustment Within 24 hours of notification from USPS.
    CREDIT ADJUSTMENT A manual credit. The same day.
    DEBIT ADJUSTMENT A manual debit. The same day.
  2. Transactions are returned in UTC/GMT time.

  3. All the transactions associated with a given shipment use the same value for the transactionId field. Therefore, a given transaction ID can appear multiple times in a report. Each occurrence represents a different transaction for the same shipment.

    The transactionId comprises the developer ID and the shipment’s X-PB-TransactionId, separated by an underscore:

    <developer_id>_<X-PB-TransactionId>

  4. If you leave out the fromDate query parameter, the parameter defaults to 31 days prior to the current date.

    Exception: If you specify any of the following parameters, the fromDate defaults to the beginning of Unix epoch (Jan. 1, 1970):

    • toDate
    • transactionId
    • parcelTrackingNumber
  5. For additional information, please see the Transaction Reports FAQs.

Request URIs

Sandbox: https://api-sandbox.pitneybowes.com/shippingservices/v4/ledger/developers/{developerId}/transactions/reports
Production: https://api.pitneybowes.com/shippingservices/v4/ledger/developers/{developerId}/transactions/reports

Path Parameter

Name Description
developerId
Required. Your Pitney Bowes developer ID.

Query Parameters

Query parameters are optional.

Name Description
fromDate

The beginning of the date range for the returned transactions. Specify this value in UTC using the ISO 8601 standard.

Important: You must include both date and time, and you must end the time with Z to indicate a zero offset. For example:

fromDate=2018-10-05T00:00:00Z
toDate

The end of the date range for the returned transactions. Specify this value in UTC using the ISO 8601 standard.

Important: You must include both date and time, and you must end the time with Z to indicate a zero offset. For example:

toDate=2018-11-02T23:59:00Z
transactionId

Returns all transactions associated with a specific label. The parameter identifies the label by a string that comprises the developer ID and the shipment’s X-PB-TransactionId, separated by an underscore (_):

<developer_ID>_<X-PB-TransactionId>

For example:

44397664_ad507ef7414a78ac22b3
parcelTrackingNumber Returns all transactions associated with a specific label. The parameter identifies the label by the shipment’s tracking number.
merchantId Returns all transactions for a specific merchant. Enter the merchant’s Shipper ID. The Shipper ID is found in the postalReportingNumber field in the Merchant Object.
transactionType

Returns all transactions of a given transaction type. Valid values:

  • POSTAGE FUND: The funding of a postage account.
  • POSTAGE PRINT: The printing of a label.
  • POSTAGE REFUND: A refund request or the resolution of a refund request.
  • FEE: An ACH return fee. The status field indicates whether the fee is processed or waived.
  • APV-POSTAGE ALL: Any APV adjustment, including both overpays and underpays.
  • APV-POSTAGE OVERPAID: An APV adjustment for overpayment.
  • APV-POSTAGE UNDERPAID: An APV adjustment for underpayment.
  • APV-DISPUTE ADJUSTMENT: A dispute of an APV-POSTAGE UNDERPAID transaction.
  • CREDIT ADJUSTMENT: A manual credit.
  • DEBIT ADJUSTMENT: A manual debit.
printStatus

Returns all Scan-Based Return labels of a given status. Valid values:

  • SBR: All SBR labels, both scanned labels and labels that are printed but not yet scanned into the USPS mailstream.
  • SBRPrinted: SBR labels that are printed but not yet scanned into the mailstream.
  • SBRCharged: SBR labels that are scanned into the mailstream.
shipDetails

Indicates whether to return the following fields for each transaction:

  • dimensionalWeightOz
  • valueOfGoods
  • specialServices
  • customMessage1
  • customMessage2

If set to 1, the fields are returned. If set to 0, the fields are not returned.

Default: 0

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

Sorts on the transactionDateTime property.

By default, the API returns transactions in ascending chronological order. You can use the sort parameter to return transactions in descending chronological order by specifying the following:

sort=transactionDateTime,desc

Request Headers

Name
Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
Accept-Language Language and country code. Default: en-US
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[Transaction Object]

The transactions. Each object in the array is a separate transaction. The Transaction Object is described in the next table below.

Note: Multiple transactions can share the same transactionId.

searchCriteria Object

The query parameters and the developer ID. The following is returned for a query on merchantId and transactionType:

{
    "developerId": "44397664",
    "merchantId": "9024324564",
    "transactionType": "POSTAGE PRINT",
    "fromDate": "2019-03-16T18:33:12.358+0000",
    "toDate": "2019-04-16T18:33:12.358+0000"
}

Note that the object always returns the fromDate and toDate parameters, even if you leave them out of the query.

last Boolean If true, this is the last page of the result set.
totalPages Number Total Number of pages in the result set.
totalElements Number Total number of transactions in the result set for the specified query filters.
sort Array[Object]

An object that contains information about the sort order, including the property used to sort the transactions. For example:

{
    "direction": "DESC",
    "property": "transactionDateTime",
    "ignoreCase": false,
    "nullHandling": "NATIVE",
    "descending": true,
    "ascending": false
}
numberOfElements Number Number of transactions in the current page.
first Boolean If true, this is the first page of the result set.
size Number

Number of transactions per page in the result set.

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

Response Elements: Transaction Object

Name Data Type Description
transactionId String

The ID used to uniquely identify the shipment associated with the transaction. The ID is a combination of the developer ID and the shipment’s X-PB-TransactionId, separated by an underscore (_):

<Developer-ID>_<X-PB-TransactionId>

transactionDateTime String The date and time of the transaction, specified using ISO 8601.
transactionType String

Type of transaction. Valid values:

  • POSTAGE FUND: The funding of a postage account.
  • POSTAGE PRINT: The printing of a label.
  • POSTAGE REFUND: A refund request or the resolution of a refund request.
  • FEE: An ACH return fee. The status field indicates whether the fee is processed or waived.
  • APV-POSTAGE OVERPAID: An APV adjustment for overpayment.
  • APV-POSTAGE UNDERPAID: An APV adjustment for underpayment.
  • APV-DISPUTE ADJUSTMENT: A dispute of an APV-POSTAGE UNDERPAID transaction.
  • CREDIT ADJUSTMENT: A manual credit.
  • DEBIT ADJUSTMENT: A manual debit.
developerName String Name of the developer account used to print the shipment label.
developerId String The developer ID used to print the shipment label.
developerPostagePaymentMethod String The developer’s PB Postage Account payment method. This is populated only for transactions that use the Bulk Postage Account payment model, as described in Merchant Enrollment Models.
developerRatePlan String Rate plan of the developer (integrator).
developerRateAmount String

Amount charged to the developer. The amount is based on the developer’s rate plan. If the merchant (shipper) has an NSA, the amount is instead based on the NSA.

APV Adjustments: If the transaction is an APV adjustment, this field is the difference between the charge that was calculated at the time of print and the charge calculated by USPS.

developerPostagePaymentAccountBalance String This field is not used to report data at this time. This field always returns the null value.
merchantName String Name of the merchant.
merchantId String The value of the postalReportingNumber field in the Merchant object. This value is also the merchant’s Shipper ID.
merchantPostageAccountPaymentMethod String The merchant’s PB Postage Account payment method. This is populated only for transactions that use the Individual Postage Account payment model, as described in Merchant Enrollment Models.
merchantRatePlan String Rate plan of the merchant (shipper).
merchantRate String

Amount charged to the merchant. This is based on the merchant’s shipper rate plan.

APV Adjustments: If the transaction is an APV adjustment, this field is the difference between the charge to the merchant calculated at the time of print and the charge calculated based on information from USPS.

shipperPostagePaymentAccountBalance String

Postage balance in the merchant’s PB Postage Account. This is the ending balance after this transaction was processed.

If this field is negative, the merchant must refill the postage account. See How do I fill my PB Postage Account with funds?

labelFee String Currently not used.
parcelTrackingNumber String Tracking number.
weightInOunces String Weight in ounces. In the case of an APV adjustment, this is based on the new information received from USPS.
zone String Zone. In the case of an APV adjustment this is based on the new information received from USPS.
packageLengthInInches String Package length in inches. In the case of an APV adjustment, this is based on the new information received from USPS.
packageWidthInInches String Package width in inches. In the case of an APV adjustment, this is based on the new information received from USPS.
packageHeightInInches String Package height in inches. In the case of an APV adjustment, this is based on the new information received from USPS.
packageTypeIndicator String

Indicates whether cubic pricing was used. Valid values:

  • Cubic
  • NonCubic

In the case of an APV adjustment, this is based on the new information received from USPS.

packageType String

The parcel type. For supported parcel types, see the carrier’s reference page.

In the case of an APV adjustment, this is based on the new information received from USPS.

mailClass String Mail class or service.
internationalCountryGroup String International country group code.
originationAddress String Origination address.
originZip String Origin postal code.
destinationAddress String Destination address.
destinationZip String Destination postal code.
destinationCountry String Destination country.
postageDepositAmount String Postage deposit amount.
creditCardFee String Credit card fee.
printStatus String

The status of a USPS SBR label:

  • SBRPrinted: The SBR label has been printed but has not been scanned in to the USPS mailstream.
  • SBRCharged: The SBR label has been scanned into the USPS mailstream.
  • NULL: The label is a prepaid outbound label (i.e., not an SBR label).
shipmentId String The unique identifier for the shipment generated when the shipment was created.
refundStatus String

Refund status. Possible values include:

  • REQUESTED
  • ACCEPTED
  • DENIED

For more information on refunds, see Refunds FAQs.

refundDenialReason String The reason for a refund denial.
refundRequestor String

Indicates who requested the refund.

  • Shipper Requested: The shipper requested the refund.
  • PB Claims: The request is part of the Delivery Guarantee program.
adjustmentReason String

APV Only. The reason for an APV adjustment, based on information received from USPS.

For an APV adjustment, possible values are:

  • Weight
  • Dimension
  • Package
  • Zone
externalId String

Applies only to the following:

  • APV adjustments: The USPS Revenue Assurance ID assigned to the APV adjustment in case of a dispute.
  • PB Delivery Guarantee: This is an ID beginning with “PBD” and followed by sequence of numbers. This indicates a Delivery Guarantee credit.
meterNumber String Internal identification number for the postage meter that was used.
dimensionalWeightOz BigDecimal

API v4.0 Only. Returned only if the shipDetails query parameter is set to 1.

This field contains the dimensional weight, if applicable.

valueOfGoods BigDecimal

API v4.0 Only. Returned only if the shipDetails query parameter is set to 1.

This field contains the value provided in the parcel.valueOfGoods field in the Create Shipment request, if applicable.

specialServices Array[Object]

API v4.0 Only. Returned only if the shipDetails query parameter is set to 1.

This array contains the shipment’s special services, including the fee paid for each service.

status String

API v4.0 Only. For the following types of transactions, this field shows the transaction status:

  • ACH transaction. Possible values:
    • Pending: A POSTAGE FUND transaction is pending.
    • Processed: Either a POSTAGE FUND or a FEE transaction has been processed.
    • Returned: A POSTAGE FUND transaction failed.
    • Waived: A FEE has been waived.
  • APV dispute. Possible values:
    • REQUESTED
    • ACCEPTED
    • DENIED
  • Return label (Sandbox only). Possible values:
    • Printed
    • Charged
description String

API v4.0 Only. Details on the status of an ACH transaction. Possible values:

  • Postage Fund Pending: A POSTAGE FUND transaction is pending.
  • Postage Fund Processed: A POSTAGE FUND transaction has been processed.
  • Postage Fund Returned: A POSTAGE FUND transaction failed.
  • ACH Return Fee Processed: A FEE has been processed.
  • ACH Return Fee waived: A FEE has been waived.
customMessage1 String

API v4.0 Only. Returned only if the shipDetails query parameter is set to 1.

This fields contains the message specified in the PRINT_CUSTOM_MESSAGE_1 shipment option in the Create Shipment request.

customMessage2 String

API v4.0 Only. Returned only if the shipDetails query parameter is set to 1.

This fields contains the message specified in the PRINT_CUSTOM_MESSAGE_2 shipment option in the Create Shipment request.

Sample Requests

See the following examples:

API v4.0 Sample Request

curl -X GET .../v4/ledger/developers/44397664/transactions/reports?shipDetails=1 \
-H "Authorization: Bearer <oauth_token>" \
-H "Accept-Language:en-US" \
-H "X-PB-UnifiedErrorStructure: true"

API v4.0 Sample Response

The response below shows three transactions for the same shipment:

  • The printing of the label
  • The request for a refund
  • The approval of the refund request

The transactionType field shows the type of transaction.

{
    "content": [ {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-01T02:30:04.025+0000",
        "transactionType": "POSTAGE PRINT",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": null,
        "shipperPostagePaymentAccountBalance": 1803.41,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": null,
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": null,
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113",
        "dimensionalWeightOz": null,
        "valueOfGoods": 0,
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "fee": 0,
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "0"
            } ]
        } ],
        "status": "",
        "description": null,
        "customMessage1": null,
        "customMessage2": null
    },
    {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-02T00:00:00.000+0000",
        "transactionType": "POSTAGE REFUND",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": null,
        "shipperPostagePaymentAccountBalance": 1547.53,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": "REQUESTED",
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": "Shipper Requested",
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113",
        "dimensionalWeightOz": null,
        "valueOfGoods": 0,
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "fee": 0,
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "0"
            } ]
        } ],
        "status": "",
        "description": null,
        "customMessage1": null,
        "customMessage2": null
    },
    {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-14T11:19:20.864+0000",
        "transactionType": "POSTAGE REFUND",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": 3.5,
        "shipperPostagePaymentAccountBalance": 1700.97,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": "ACCEPTED",
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": "Shipper Requested",
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113",
        "dimensionalWeightOz": null,
        "valueOfGoods": 0,
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "fee": 0,
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "0"
            } ]
        } ],
        "status": "",
        "description": null,
        "customMessage1": null,
        "customMessage2": null
    }, ... ],
    "searchCriteria": {
        "developerId": "44397664",
        "fromDate": "2019-03-01T00:00:00.000+0000",
        "toDate": "2019-03-31T23:59:59.000+0000"
    },
    "last": false,
    "totalPages": 2,
    "totalElements": 27,
    "sort": [ {
        "direction": "ASC",
        "property": "transactionDateTime",
        "ignoreCase": false,
        "nullHandling": "NATIVE",
        "descending": false,
        "ascending": true
    } ],
    "numberOfElements": 20,
    "first": true,
    "size": 20,
    "number": 0
}


API v2.0 Sample Request

curl -X GET .../v2/ledger/developers/44397664/transactions/reports?fromDate=2019-03-01T00:00:00Z&toDate=2019-03-31T23:59:59Z \
-H "Authorization: Bearer <oauth_token>" \
-H "Accept-Language:en-US" \
-H "X-PB-UnifiedErrorStructure: true"

API v2.0 Sample Response

The response below shows three transactions for the same shipment:

  • The printing of the label
  • The request for a refund
  • The approval of the refund request

The transactionType field shows the type of transaction.

{
    "content": [ {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-01T02:30:04.025+0000",
        "transactionType": "POSTAGE PRINT",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": null,
        "shipperPostagePaymentAccountBalance": 1803.41,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": null,
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": null,
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113"
    },
    {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-02T00:00:00.000+0000",
        "transactionType": "POSTAGE REFUND",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": null,
        "shipperPostagePaymentAccountBalance": 1547.53,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": "REQUESTED",
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": "Shipper Requested",
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113"
    },
    {
        "transactionId": "44397664_a7-4bc2-a17a-02a37ad84a5d",
        "transactionDateTime": "2019-03-14T11:19:20.864+0000",
        "transactionType": "POSTAGE REFUND",
        "developerName": "PB",
        "developerId": "44397664",
        "developerPostagePaymentMethod": null,
        "developerRatePlan": null,
        "developerRateAmount": 3.5,
        "developerPostagePaymentAccountBalance": null,
        "merchantName": "Smith",
        "merchantId": "9024324564",
        "merchantPostageAccountPaymentMethod": "OTHER",
        "merchantRatePlan": null,
        "merchantRate": 3.5,
        "shipperPostagePaymentAccountBalance": 1700.97,
        "labelFee": null,
        "parcelTrackingNumber": "0400109205168000244595",
        "weightInOunces": 10,
        "zone": "",
        "packageLengthInInches": 6,
        "packageWidthInInches": 2,
        "packageHeightInInches": 4,
        "packageTypeIndicator": "NonCubic",
        "packageType": "PKG",
        "mailClass": "First-Class Mail",
        "internationalCountryPriceGroup": null,
        "originationAddress": "27 Waterview Dr,Shelton,CT,06484",
        "originZip": "06484",
        "destinationAddress": "625 S Main St,Greenville,SC,29601",
        "destinationZip": "29601250431",
        "destinationCountry": "US",
        "postageDepositAmount": null,
        "creditCardFee": null,
        "refundStatus": "ACCEPTED",
        "refundDenialReason": null,
        "printStatus": null,
        "shipmentId": "USPS2200487400865080",
        "refundRequestor": "Shipper Requested",
        "externalId": null,
        "adjustmentReason": null,
        "meterNumber": "0001259113"
    }, ... ],
    "searchCriteria": {
        "developerId": "44397664",
        "fromDate": "2019-03-01T00:13:49.313+0000",
        "toDate": "2019-04-01T00:13:49.313+0000"
    },
    "last": false,
    "totalPages": 2,
    "totalElements": 27,
    "sort": [ {
        "direction": "ASC",
        "property": "transactionDateTime",
        "ignoreCase": false,
        "nullHandling": "NATIVE",
        "descending": false,
        "ascending": true
    } ],
    "numberOfElements": 20,
    "first": true,
    "size": 20,
    "number": 0
}

Error Codes

The following error code is specific to Transaction Reports.

Error Code Error Message Solution
invalid.date.time Provided Date/time ___ is invalid, valid format is YYYY-MM-DDThh:mm:ss.sZ See the explanations of fromDate and toDate above in Query Parameters.

For a list of all PB Shipping APIs error codes, please see Error Codes.