Reprint Batch Container Labels for CBDS Inbound¶

HTTP Request¶

GET /v1/container-manifest/batch/{ID}

Summary¶

This operation reprints a batch of container labels printed through the Batch Container Labels API.

Request URLs¶

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v1/container-manifest/batch/{ID}
Production: https://shipping-api.pitneybowes.com/shippingservices/v1/container-manifest/batch/{ID}

Path Parameter¶

Name	Description
ID	Required. The value returned in the `batchContainerManifestId` field in the original Print Batch Container Labels request.

Request Headers¶

Name

Description

Authorization

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

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
containers	Array[Container Object]	The containers to be shipped. The array contains an object for each container to be shipped.
documents	Array[Object]	The returned container labels.
documents.contentType	String	Returns the following to indicate the label is a Base64-encoded string that must be converted to a PDF: `BASE64` To convert the string, use a tool that converts Base64 to the application/pdf MIME type.
documents.fileFormat	String	Returns the following to indicate the file format for the printable label: `PDF`
documents.size	String	Returns the following to indicate label size is 4 x 6: `DOC_4X6`
documents.contents	String	The Base64-encoded string that converts to a PDF. The PDF contains the container labels. Each label is a different page in the PDF. To convert, use a tool that converts Base64 to the application/pdf MIME type.
documents.type	String	Returns the following to indicate the label is a container label: `CONTAINER_LABEL`
references	Array[Object]	Contains key-value pairs that specify shipper reference values. Each object in the array has a `name` field set to the reference type and a `value` field set to the reference value. Both fields take strings. The `name` field can have the following reference types: `CLIENT_REFERENCE_NUMBER`: A unique shipment number generated by the shipper. `CLIENT_GROUND_REFERENCE_NUMBER`: A unique ground reference number (truck number) generated by the shipper. `CLIENT_AIR_REFERENCE_NUMBER`: A unique air reference number (airline number) generated by the shipper.
parameters	Array[Object]	Contains a key-value pair that specifies the CBDS Hub that receives the containers.
parameters.name	String	Returns `CARRIER_FACILITY_ID` to indicated the parameter is a facility ID.
parameters.value	String	The CBDS Hub that receives the containers. Possible values: `US_GLOBAL_ILA`: Chicago `US_GLOBAL_NJA`: New Jersey `US_GLOBAL_WAA`: Washington state
batchContainerManifestId	String	The unique shipment number generated by Pitney Bowes. This number appears as barcode and number on each container label returned in the PDF.

Container Object¶

Name	Data Type	Description
clientContainerId	String	The number for the container generated by the shipper.
containerType	String	The type of container used to transport the parcels. Valid values: `AIRHAUL` `BOX` `GAYLORD`
tareWeight	Object	The weight of the container before parcels are added.
tareWeight.Weight	Big Decimal	The weight of the empty container.
tareWeight.unitOfMeasurement	String	The unit of measure for the tare weight. Valid values: `LB`: pounds `KG`: kilograms `OZ`: ounces
dimension	Dimension Object	The container’s dimensions.
totalParcelWeight	Object	The total scaled weight of all the parcels in the container, without the container weight (tare weight).
totalParcelWeight.Weight	Big Decimal	The total scaled weight of all the parcels in the container, without the container weight (tare weight).
totalParcelWeight.unitOfMeasurement	String	The unit of measure for the total scaled weight. Valid values: `LB`: pounds `KG`: kilograms
parcelTrackingNumbers	Array[Strings]	The tracking numbers of the parcels on the container.

Sample Request¶

curl -X GET ".../v1/container-manifest/batch/OBMEL123456789' \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: 1234567890"

Sample Response¶

{
    "containers": [ {
        "clientContainerId": "c1112136513-PC1",
        "containerType": "BOX",
        "tareWeight": {
            "unitOfMeasurement": "LB",
            "weight": 8.10
        },
        "dimension": {
            "length": 48.0,
            "height": 24.5,
            "width": 36.0,
            "unitOfMeasurement": "IN"
        },
        "totalParcelWeight": {
            "unitOfMeasurement": "LB",
            "weight": 1.0
        },
        "parcelTrackingNumbers": [
            "UPBEE001000000000A16",
            "UPBEE001000000000A12",
            "UPBEE001000000000917",
            "UPBEE001000000000918",
            "UPBEE001000000000915"
        ]
    },
    ...
    ],
    "documents": [ {
        "contentType": "BASE64",
        "fileFormat": "PDF",
        "size": "DOC_4X6",
        "contents": "JVBERi0xLjMNCjE3umAG ...",
        "type": "CONTAINER_LABEL"
    } ],
    "references": [ {
        "name": "CLIENT_REFERENCE_NUMBER",
        "value": "1234"
    } ],
    "parameters": [ {
        "name": "CARRIER_FACILITY_ID",
        "value": "US_GLOBAL_ILA"
    } ],
    "batchContainerManifestId": "OBMEL123456789"
}

Error Codes¶

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