Reprint a Container Label for Shipment to a CBDS Hub¶

Note

This operation is coming soon to Sandbox.

HTTP Request¶

GET /v2/container-manifest/{shipmentId}?carrier=PBI

Summary¶

This operation retrieves a container label that was created with the CBDS Container Label API but was spoiled or lost. To use this operation, you must know the shipmentId returned by the original CBDS Container Label request. The API allows three attempts to reprint a container label.

Important: Reprints should be used only in the case of spoiled or lost data. The number of reprints are scrutinized and restricted.

Do not use this operation if the original CBDS Container Label request failed to respond or returned an error. Instead, do one of the following:

If the original request returned no response or returned the HTTP 500 error, use the Retry Container Label API to see if the label was created. If it was, the Retry API will return the label.
If the original request returned any other error, other than HTTP 500, issue a new CBDS Container Label request with a new Transaction ID.

Request URLs¶

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

Path Parameter¶

Name	Description
shipmentId	Required. The `shipmentId` that was returned as part of the original Create CBDS Container Label request.

Query Parameter¶

Name	Description
carrier	Required. Indicates the label is a CBDS container label. Set this to the following: `PBI`

Request Header¶

Name

Description

Authorization

Required. OAuth token generated using the Generate an OAuth Token API.

Response Elements¶

Name	Data Type	Description
containerType	String	The type of container. This is set to: `MasterCarton`
fromAddress	Address Object	The container’s origin address.
weight	Object	The weight of the container when empty.
weight.weight	Big Decimal	The weight.
weight.unitOfMeasurement	String	The weight’s unit of measure. Possible values: `LB`: pounds `KG`: kilograms `OZ`: ounces
dimension	Dimension Object	The container’s dimensions.
parcelTrackingNumbers	Array[Strings]	The tracking numbers of the parcels in the container.
documents	Array[Object]	This object contains two labels.
documents.type	String
documents.fileFormat	String	The file format for the printable label. This is set to: `PDF`
documents.size	String	The label size. This is set to: `DOC_4X6`
documents.contentType	String	Indicates the label is retrieved through a URL. This is set to: `URL`
documents.printDialogOption	String	If this is set to `EMBED_PRINT_DIALOG`, then opening the PDF automatically opens the Print dialog box.
documents.contents	String	The URL to access the container label. The label is available for 24 hours after it is created.
rates	Array[Object]	The carrier, service, and charges.
rates.carrier	String	This is set to: `PBI`
rates.serviceId	String	This is set to: `PBMDS`
rates.parcelType	String	This is set to: `PKG`
rates.baseCharge	Double	The cost without fees, surcharges, discounts, special services, or taxes.
rates.totalCarrierCharge	Double	The total cost.
rates.deliveryCommitment	Object	The expected time in transit for the container. The object contains the following fields: `minEstimatedNumberOfDays` (String): The minimum number of delivery days. `maxEstimatedNumberOfDays` (String): The maximum number of delivery days.
rates.currencyCode	String	The type of currency used for the charges. For example: `USD`, `CAD`, `EUR`
rates.destinationZone	Number	The destination zone used to determine the rate. The zone is based on the origin address and address of the destination hub.
domesticShipmentDetails	Object	The printed label’s tracking number. The object contains the following fields: `shipperTrackingNumber` (String): The tracking number for the first-mile leg to the CBDS Hub. `barCodeLabelNumber` (String): The tracking number for the first-mile leg to the CBDS Hub.
parameters	Array[Object]	Each object in the array is a name-value pair with the following two fields: `name` (String): One of the parameters described in this table on the Create CBDS Container Label page. `value` (String): The parameter value.
shipmentId	String	A unique identifier for the contain label generated by Pitney Bowes.
parcelTrackingNumber	String

Sample Request¶

curl -X GET ".../v2/container-manifest/{shipmentId}?carrier=PBI" \
-H "Authorization: Bearer <oauth_token>"

Sample Response¶

{
    "containerType": "MasterCarton",
    "fromAddress": {
        "name": "Jim Smith",
        "company": "Supplies",
        "addressLines": [
            "500 Warehouse Drive"
        ],
        "cityTown": "Marietta",
        "stateProvince": "SC",
        "postalCode": "29661",
        "countryCode": "US"
    },
    "weight": {
        "unitOfMeasurement": "LB",
        "weight": "0.005"
    },
    "dimension": {
        "unitOfMeasurement": "in",
        "length": "5",
        "width": "2",
        "height": "3"
    },
    "parcelTrackingNumbers": [
        "PBXGA000000000010000",
        "PBXGA000000000002000",
        "PBXGA000000000300000",
        "PBXGA000000000000400"
    ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "fileFormat": "PDF",
        "size": "DOC_4X6",
        "contentType": "URL",
        "printDialogOption": "NO_PRINT_DIALOG",
        "contents": "<first mile label>"
    },{
        "type": "MASTERCARTON_LABEL",
        "fileFormat": "PDF",
        "size": "DOC_4X6",
        "contentType": "URL",
        "printDialogOption": "NO_PRINT_DIALOG",
        "contents": "<container label>"
    } ],
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBMDS",
        "parcelType": "PKG",
        "baseCharge": 26.88,
        "totalCarrierCharge": 26.88,
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "6",
            "maxEstimatedNumberOfDays": "10"
        },
        "currencyCode": "USD",
        "destinationZone": 1.0
    } ],
    "domesticShipmentDetails": {
        "shipperTrackingNumber": "7624003CPC0000042004Z",
        "barCodeLabelNumber": "7624003CPC0000042004Z"
    },
    "parameters": [ {
        "name": "CLIENT_REFERENCE_NUMBER",
        "value": "ClientRef-1195"
    }, {
        "name": "SHIPPER_ID",
        "value": "SHID1111"
    }, {
        "name": "CARRIER_FACILITY_ID",
        "value": "US_ELOVATIONS_KY"
    } ],
    "parcelTrackingNumber": "PBXGA000000000000777",
    "shipmentId": "PBXGA000000000000777"
}

Error Codes¶

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