Void Parcel Protection Coverage

HTTP Request

POST /v1/parcel-protection/void?parcelProtectionReferenceId={policyId}

Summary

This operation voids the Parcel Protection coverage for a shipment.

Prerequisites

To use this API, both your developer account and the merchant’s account must be enabled for Parcel Protection. For instructions, see Enabling Parcel Protection Coverage.

Things to Consider

  1. To cancel coverage, the merchant must provide the Parcel Protection Policy ID returned in the parcelProtectionReferenceID field in the response of the original Request Parcel Protection Coverage API call.
  2. Merchants cannot void coverage for packages that have already shipped or been delivered.
  3. The refund for the voided Parcel Protection coverage appears as a service credit on the merchant’s bill from Pitney Bowes.
  4. For more information on the Parcel Protection program, including FAQs, please see the PB Parcel Protection web page.

Request URIs

Sandbox: https://api-sandbox.pitneybowes.com/shippingservices/v1/parcel-protection/void?parcelProtectionReferenceId={policyId}
Production: https://api.pitneybowes.com/shippingservices/v1/parcel-protection/void?parcelProtectionReferenceId={policyId}

Query Parameter

Name Description
parcelProtectionReferenceId Required. The identifier for the PB Parcel Protection policy that is being voided.

Request Headers

Name
Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
Content-Type Required. The media type of the request entity. Set this to application/json.
Accept-Language Language and country code. Default: en-US
X-PB-TransactionId

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

Request Elements

Name Data Type Description
shipperID String The merchant’s Shipper ID. The Shipper ID is found in the postalReportingNumber field in the merchant object.
parcelProtectionAccountID String Parcel Protection account ID, if applicable.

Response Elements

Name Data Type Description
status String Returns a value of Void_Success to indicate that parcel protection coverage was successfully voided.

Sample Request

curl -X POST .../v1/parcel-protection/void?parcelProtectionReferenceId=IPPOL0010088026244' \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type:application/json" \
-H "X-PB-TransactionId: 12345678-705476" \
-H "X-PB-UnifiedErrorStructure: true" \
-d '
{
    "shipperID": "9024324564",
    "parcelProtectionAccountID": "IPACT2345678"
}'

Sample Response

{
    "status": "Void_Success"
}

Error Codes

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

The following error code is specific to this API:

errorCode errorDescription additionalInfo
131 ParcelProtectionID was voided parcelProtectionID