Reprint a Master Carton if the Original Data was Spoiled or Lost¶

HTTP Request¶

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

Summary¶

This operation retrieves the labels from a successful Create Master Carton request if the original data was spoiled or lost. To use this operation, you must know the shipmentId returned by the original Create Master Carton request. The API allows three attempts to retrieve the data.

Important: . Use this only if the original data was spoiled or lost. The number of reprints are scrutinized and restricted.

Do not use this operation if the original Create Master Carton 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 Master Carton API to see if the labels were created. If they were, the Retry API will return the labels.
If the original request returned any other error, other than HTTP 500, issue a new Create Master Carton 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` returned by the original Create Master Carton request.

Query Parameter¶

Name	Description
carrier	Required. Set this to the following to indicate the master carton is a CBDS container: `PBI`

Request Headers¶

Name

Description

Authorization

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

Content-Type

The media type of the request entity. Set this to: application/json

Response Elements¶

The API returns the same response as the original Create Master Carton request. For response elements, see Response Elements on the Create Master Carton page.

Sample Request¶

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

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_GLOBAL_ILA"
    } ],
    "parcelTrackingNumber": "PBXGA000000000000777",
    "shipmentId": "PBXGA000000000000777"
}

Error Codes¶

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