Delete a Container Label for Shipment to a CBDS Hub

Note

This operation is coming soon to Sandbox.

HTTP Request

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

Summary

This operation cancels an unused container label that was created using the CBDS Container Label API.

The container’s parcels will not be voided and will still be processed at the hub once delivered.

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 CBDS Container Label request.

Query Parameters

Name

Description

carrier

Required. Indicates the label is a CBDS label. Set this to: PBI``

cancelInitiator

Required. Indicates the cancelation is requested by the shipper. Set this to: 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

The initiator of the cancelation. This field returns: SHIPPER

carrier

String

The type of container label. This field returns: 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>" \
-H "X-PB-Shipper-Carrier-AccountId: <unique_carrier_account_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.