Void Batch Shipping Labels

Request

This operation cancels (voids) shipments which are created using the Batch API operation createBulkShipments.
If user wants to cancel specific shipment(s) of the Batch, then s/he needs to pass the Shipment ID for the selected shipments in the shipmentIDs array. While if user wants to cancel all shipments of the Batch, then s/he does not need to provide any Shipment ID in the array under request body.

Key Considerations

Cancelation must occur before the shipment is picked up or processed by the carrier.
Refunds are only applicable for unused labels. Voiding a used label may result in penalties or billing.
Refunds are subject to the policies of the applicable carrier.
Refund requests must be submitted within 30 days from the date the label was printed.
USPS may take up to 30 days to process the refund.
The refund status can be tracked on the History page.
Approved refunds will be credited back to the USPS postage balance.
The label status will change to Refunded once the refund is processed.
For unused post-paid labels, you must void them. Voiding avoids billing for the label and allows the carrier to maintain an accurate count for pickups.
Always destroy voided labels to prevent accidental use. If a voided label is shipped, you will be billed for the label.
Once a refund has been claimed, you cannot use the shipping label for sending packages. It will be rejected.
Submitting false or fraudulent refund claims is a federal offense, punishable by fines or imprisonment.

Security

bearerAuth

Path

batchIdstringrequired

This is a system-generated unique identifier assigned to the Batch while it is processed.

X-PB-Developer-Partner-IDstring

The Developer-Partner-ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required.

Bodyapplication/json

This is the request body for cancelling the selected shipments or entire Batch of shipments*.

namestringrequired

Indicates the name of the Batch, i.e., a list of shipments, which need to be cancelled.

Example:"batchTest"

reasonstring

Reason to cancel the batch of shipments.

Example:"Not processing due to rating issue."

shipmentIdsArray of strings

Shipment ID is a unique identifier for an individual shipment. If ShipmentID(s) are passed in the array, then corresponding shipments will be cancelled. If ShipmentID(s) is/are not provided, then the entire shipments of the Batch will be cancelled.

Example:

[
  "USPS09998889999038"
]

curl -i -X POST \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shipments/batch/{batchId}/void' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-ID: string' \
  -d '{
    "name": "batchTest",
    "reason": "Not processing due to rating issue.",
    "shipmentIds": [
      "USPS09998889999038"
    ]
  }'

Responses

The indicated shipment(s) of Batch have been successfully cancelled.

Bodyapplication/json

batchIDstring

This is a system-generated unique identifier assigned to the Batch while it is processed.

Example:"p1B9VZYVp5V"

statusstring

Indicates the status of the Batch while executing voidShippingLabel.

Example:"RATE_VALIDATION_FAILED"

Response

{
  "batchID": "p1B9VZYVp5V",
  "status": "RATE_VALIDATION_FAILED"
}