Delete a Master Carton Shipping Label¶

HTTP Request¶

DELETE /v2/container-manifest/{shipmentId}?carrier=PBI&cancelInitiator=SHIPPER

Summary¶

This operation voids an unused master carton shipping label that was created through the Create Master Carton API.

This operation does not void the master carton’s parcels.

Request URLs¶

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v2/container-manifest/{shipmentId}?carrier=PBI&cancelInitiator=SHIPPER
Production: https://shipping-api.pitneybowes.com/shippingservices/v2/container-manifest/{shipmentId}?carrier=PBI&cancelInitiator=SHIPPER

Path Parameter¶

Name	Description
shipmentId	Required. The `shipmentId` returned by the original Create Master Carton request.

Query Parameters¶

Name	Description
carrier	Required. Set this to the following to indicate the master carton is a CBDS container: PBI``
cancelInitiator	Required. Set this to the following to indicate the cancelation is requested by the shipper: `SHIPPER`

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

X-PB-TransactionId

Required. A unique identifier for the transaction, up to 25 characters. The following characters are allowed: letters, numbers, hyphens (-), and underscores (_).

Important: Ensure this is a unique ID.

Response Elements¶

Name	Data Type	Description
cancelInitiator	String	Returns the following value to indicate the shipper initiated the cancelation: `SHIPPER`
carrier	String	Returns the following value to indicate the master carton is a CBDS container: `PBI`
parcelTrackingNumber	String	The tracking number of the original label.
status	String	The status of the shipment cancelation. Possible values: `INITIATED` `APPROVED`

Sample Request¶

curl -X DELETE ".../v2/container-manifest/{shipmentId}?carrier=PBI&cancelInitiator=SHIPPER \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <unique_id>"

Sample Response¶

{
    "cancelInitiator": "SHIPPER",
    "carrier": "PBI",
    "parcelTrackingNumber": "<tracking-number>",
    "status": "APPROVED"
}

Error Codes¶

For a list of all error codes returned by the Ecommerce APIs, please see Error Codes.