Navigation

  • next
  • previous |
  • Global Ecommerce APIs »
  • Containers »

Print a Container Label for Shipment to a CBDS Hub¶

Note

This operation is coming soon to Sandbox.

HTTP Request¶

POST /v2/container-manifest

Summary¶

This operation prints a container label for first-mile shipment of containerized parcels to a CBDS Hub. The operation print a label for containerized CBDS Outbound parcels. At the hub, CBDS processes the parcels and ships them to their international destinations.

The operation returns a container label and unique shipmentId that identifies the label.

Note: To instead print container labels for PB Standard, see this operation.

Request URLs¶

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v2/container-manifest
Production: https://shipping-api.pitneybowes.com/shippingservices/v2/container-manifest

Request Headers¶

Name


Description

Authorization

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

X-PB-TransactionId

Required.

includeDeliveryCommitment

If set to true, returns estimated transit time. Transit time is returned as number of days.

Request Elements¶

Name

Data Type

Description

containerType

String

Required. Set this to: MasterCarton

fromAddress

Address Object

The container’s origin address.

weight

Object

The weight of the container when empty, before parcels are added.

weight.weight

Big Decimal

The weight of the empty container. If you enter a value for this field, you must also enter a value for weight.unitOfMeasurement.

weight.unitOfMeasurement

String

The unit of measure for weight.weight. Valid values are:

  • LB: pounds

  • KG: kilograms

  • OZ: ounces

dimension

Dimension Object

The container’s dimensions.

parcelTrackingNumbers

Array[Strings]

Required. The tracking numbers of the parcels in the container, entered as Strings separated by commas.

Maximum: 250 tracking numbers

documents

Array[Object]

Required. Defines the container label.

documents.type

String

“: “SHIPPING_LABEL”,

documents.fileFormat

String

The file format for the printable label. Set to: PDF

documents.size

String

The label size. Set to: DOC_4X6

documents.contentType

String

Set to: URL

documents.printDialogOption

String

Set to one of the following, as described here:

  • EMBED_PRINT_DIALOG

  • NO_PRINT_DIALOG

rates

Array[Object]

Required. Specifies the carrier, service, and container type. The array takes one object.

rates.carrier

String

Set to: PBI

rates.serviceId

String

Set to: PBMDS

rates.parcelType

String

Set to: PKG

parameters

Array[Object]

Each object in the array is a name-value pair with a name field and a value field. The name field takes one of the parameters described below in Parameters for CBDS Container Labels. Enter parameters as Strings. The value field takes the value you want to set for that parameter, entered as a String.

Parameters for CBDS Container Labels¶

The parameters array in the CBDS Container Label API can take the following parameters:

Name

Description

CLIENT_REFERENCE_NUMBER

A unique shipment number created by the shipper.

SHIPPER_ID

The shipper’s unique Shipper ID in the Pitney Bowes system.

CARRIER_FACILITY_ID

The ID of the CBDS Hub that will receive the parcel.

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

Domestic Shipment Details Object for CBDS Domestic¶

Name


Data Type

Description

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.

Sample Request¶

curl -X POST ".../v2/container-manifest" \
-H "Authorization: Bearer <oauth_token>"
-H "X-PB-TransactionId: <unique_transaction_id>"
-d '
{
    "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"
    } ],
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBMDS",
        "parcelType": "PKG"
    } ],
    "parameters": [ {
        "name": "CLIENT_REFERENCE_NUMBER",
        "value": "MerchantOrder-1195"
    }, {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    }, {
        "name": "CARRIER_FACILITY_ID",
        "value": "US_ELOVATIONS_KY"
    } ]
}

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.


 
 
 
 
  • next
  • previous |
© Copyright 2023, PB.

Quick search

Getting Started

  • API Overview
  • Getting Started

Authentication API

  • OAuth Token

Shipping APIs

  • Carriers
  • Carrier Rules
  • Address Validation
  • Rate Parcels
  • Shipments
  • Manifests
  • Containers
    • Container Label (PB Standard)
    • Container Label (CBDS)
    • Retry Container Label
    • Reprint Container Label
    • Delete Container Label
    • Print Batch Labels
    • Reprint Batch Labels
  • Tracking
  • Transaction Reports
  • Pickups
  • Cross-Border Value-Adds

Shipping APIs Reference

  • API Resources
  • API Resource Objects
  • Shipment Options
  • FAQs

Merchant Accounts APIs

  • Merchant Accounts
  • Postage Management
  • Add Carrier Accounts
  • Merchant FAQs

Fulfillment APIs

  • Fulfillment Overview
  • Products
  • ASN
  • Inventory
  • Orders
  • Shipments
  • BOM
  • Work Orders
  • Return Orders

Support

  • Release Notes
  • Error Codes
  • Best Practices
  • Traffic Shaping
  • Troubleshooting
  • Contact Us
  • Glossary