Cancel Multipiece Shipment

The operation is used to cancel the multipiece label. It takes the shipmentId of the multipiece shipment done.

SecuritybearerAuth
Request
path Parameters
shipmentId
required
string

It specifies the shipmentId of onward shipment against which return label has to be created.

header Parameters
X-PB-Developer-Partner-Id
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Responses
200

The Multipiece Shipment created successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/multipiece/shipments/{shipmentId}/cancel
Request samples 
Response samples 
application/json
{
  • "carrier": "USPS",
  • "totalCarrierCharge": 0,
  • "parcelTrackingNumber": "9471309105156000624885",
  • "status": "INITIATED"
}