Create a CBDS International Inbound Shipment¶

Note

CBDS Inbound Shipping is Coming Soon.

Note

This page contains draft content.

HTTP Request¶

POST /v1/shipments?carrier=PBI

Summary¶

This page describes international inbound shipping. CBDS also provides international outbound shipping and domestic shipping.

Considerations¶

The shipmentOptions array requires the following fields:
- SHIPPER_ID
- CARRIER_FACILITY_ID
In the customs.customsItems array, the following fields are required:
- description
- hSTariffCode
- hSTariffCodeCountry
- itemId
- originCountryCode
- quantity
- unitPrice
- url - This can be passed as an empty String, but the field must be present in the request.

Request URLs¶

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v1/shipments?carrier=PBI
Production: https://shipping-api.pitneybowes.com/shippingservices/v1/shipments?carrier=PBI

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 unique.

Request / Response Elements¶

This POST operation sends and receives the Shipment object, described here. Required fields are marked Required. All other fields are optional, with two exceptions: 1. Fields that are marked RESPONSE ONLY appear only in the response. 2. Fields that are marked as applying only to other label types do not apply to this one.

Name	Data Type	Description
shipmentType	String	Return Labels Only. For return labels, set this to `RETURN`. Required for Expedited Returns , Standard Returns, and when rating return labels. Note that you cannot rate Standard Returns. Recommended for CBDS Returns.
fromAddress	Address Object	Required. Origin address. If you want a different address to appear on the label from the one listed here, see this FAQ. The FAQ does not apply to PB Standard.
toAddress	Address Object	Required. Destination address. If you are shipping to Puerto Rico or an international destination with FedEx or UPS, and if the importer is different from the final recipient, enter the address of the importer here in the `toAddress` object. For the address of the recipient, use the `soldToAddress` object. If the importer is the same as the final recipient, the `toAddress` and `soldToAddress` must match.
altReturnAddress	Address Object	For these carriers, sets an address for parcel returns: PB Expedited: If you are sending an international shipment and if you have set the NON_DELIVERY_OPTION option to `redirect`, use this field to specify the address for a parcel return. PB Presort PMOD CBDS Outbound & CBDS Domestic: By default, parcel returns are sent to a shipment’s `fromAddress`. (Parcel returns are sent from the CBDS Hub.) If the `fromAddress` is the wrong address for your returns, then you must use the `altReturnAddress` to enter the correct address for returns. Failure to do so will result returns to the wrong address. FedEx UPS
additionalAddresses	Array[Additional Addresses Object]	CBDS Returns Only. If the seller’s address is different from the `toAddress`, enter the seller’s address here. Required if the `toAddress` and seller address are different.
parcel	Parcel Object	Required. Contains physical characteristics of the parcel.
rates	Array[Rates Object]	Required. Specifies the carrier, service, parcel, and other information. In a response, this field also contains the service charges. Important: In a request, the `rates` array can contain only one rates object.
documents	Array[Documents Object]	Required, except as noted below. Defines the label, manifest, or other shipping document created by the API call. In a response, this array provides the URL or Base64 string for a document and in some cases can contain multiple objects. This field does not apply to: - Rate Parcel API. - Create CBDS Shipment API if the merchant prints the first-mile label prior to invoking the API.
shipmentOptions	Array[Object]	Required. Each object in this array defines a shipment option. Specify each option as a name-value pair in the array. The `SHIPPER_ID` option is required. For additional requirements for a carrier, see the Considerations section on the carrier’s Create Shipment page.
shipmentOptions.name	String	The name of the shipment option.
shipmentOptions.value	String	The value of the shipment option.
customs	Object	For shipments that use customs forms, this object contains the customs information. Required in the following situations: PB Expedited: Required for shipments to international destinations. Conditional for shipments to APO/FPO/DPO, U.S. Territories, and FAS, as explained in this FAQ. CBDS: Required for all shipments. FedEx: Required for shipments to international destinations and Puerto Rico. UPS: Required for shipments to international destinations and Puerto Rico.
customs.customsInfo	Customs Info Object	Customs clearance information for the commercial invoice. Required in the `customs` object.
customs.customsItems	Array[Customs Items Object]	Customs clearance information for each commodity. Required in the `customs` object. Maximum number of objects in the array: 30
domesticShipmentDetails	Domestic Shipment Details Object	CBDS Only. The first-mile label’s tracking number and other information about the first-mile leg. Required if the merchant prints the first-mile label prior to invoking the API, as is the case with the Drop-Off to CBDS solution. Send the first-mile label’s tracking number and details. RESPONSE ONLY for all other CBDS shipment requests.
references	Array[Object]	PB Standard & CBDS Only. The merchant’s reference fields. Each object in the array includes a name-value pair that defines a reference field. See the following, depending on your carrier: References Array in a PB Standard Shipment References Array in a CBDS Shipment References Array in a CBDS Returns Shipment To pass references for carriers other than the above, see How do I Add Reference Fields for My Carrier?
hazmatDetails	Hazmat Details Object	PB Standard Only. If shipping hazardous materials with PB Standard, use this object.
carrierPayments	Array[Shipment: Carrier Payments Object]	FedEx & UPS Only. Indicates that one or more of the shipment costs should be charged to a third-party account.
soldToAddress	Address Object	FedEx & UPS Only. The final recipient of a the shipment. Required for shipments from the U.S. to Puerto Rico or international destinations. Otherwise optional. This address must match the `toAddress.countryCode`, with the exception of shipments to Canada and to U.S. satellite countries. If the final recipient’s address is the same as the importer’s address, the entries in the `soldToAddress` object must match the entries in the `toAddress` object.
shipmentId	String	RESPONSE ONLY. Unique identifier for the shipment, generated by the system in response to shipment purchase.
parcelTrackingNumber	String	RESPONSE ONLY. Tracking number assigned to the shipment by the system.

Sample Request¶

This section provides the following sample request:

For this solution:

See this example:

Drop-Off to CBDS with Final-Mile Label
Canada outbound

Sample Request for Drop-Off to CBDS with Final-Mile Label

Sample Request for Drop-Off to CBDS with Final-Mile Label¶

This request for a CBDS inbound shipment uses the Drop-Off to CBDS with Final-Mile Label solution with the CFS Standard (PBIBCS) service class.

Sample Request for Drop-Off to CBDS with Final-Mile Label¶

curl -X POST .../v1/shipments?carrier=PBI&includeDeliveryCommitment=true \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <unique_transaction_id>" \
-d '
{
    "fromAddress": {
        "name": " ",
        "addressLines": [ " " ],
        "cityTown": " ",
        "company": " ",
        "stateProvince": " ",
        "postalCode": " ",
        "countryCode": "CN"
    },
    "toAddress": {
        "name": " ",
        "addressLines": [ "500 Bd Rosemont" ],
        "cityTown": "Montréal",
        "stateProvince": "QC",
        "postalCode": ", H2S 0C4",
        "company": " ",
        "countryCode": "CA",
        "email": " ",
        "phone": " "
    },
    "parcel": {
        "weight": {
            "unitOfMeasurement": "Lb",
            "weight": "16"
        },
        "dimension": {
            "unitOfMeasurement": "In",
            "length": "5",
            "width": "2",
            "height": "3"
        },
        "currencyCode": "USD"
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBIBCS",
        "parcelType": "PKG"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_4X6",
        "fileFormat": "PDF",
        "contentType": "URL",
        "printDialogOption": "NO_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "US_GLOBAL_NJA"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "unitWeight": {
                "weight": "0.95",
                "unitOfMeasurement": "Lb"
            },
            "itemDimension": {
                "length": "10",
                "height": "8",
                "width": "6",
                "unitOfMeasurement": "In"
            },
            "itemId": " ",
            "description": " ",
            "url": " ",
            "hSTariffCode": "610120",
            "hSTariffCodeCountry": "CA",
            "originCountryCode": "CN",
            "unitPrice": "500.00",
            "quantity": "1"
        } ]
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "1234-1195"
    } ]
}'

Sample Response¶

{
    "fromAddress": {
        "name": " ",
        "addressLines": [ " " ],
        "cityTown": " ",
        "company": " ",
        "stateProvince": " ",
        "postalCode": " ",
        "countryCode": "CN"
    },
    "toAddress": {
        "name": " ",
        "addressLines": [ "500 Bd Rosemont" ],
        "cityTown": "Montréal",
        "stateProvince": "QC",
        "postalCode": ", H2S 0C4",
        "company": " ",
        "countryCode": "CA",
        "email": " ",
        "phone": " "
    },
    "parcel": {
        "weight": {
            "unitOfMeasurement": "Lb",
            "weight": "16"
        },
        "dimension": {
            "unitOfMeasurement": "In",
            "length": "5",
            "width": "2",
            "height": "3"
        },
        "currencyCode": "USD",
        "valueOfGoods": 801.76
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBIBCS",
        "parcelType": "PKG",
        "baseCharge": 20.94,
        "totalCarrierCharge": 20.94,
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "5",
            "maxEstimatedNumberOfDays": "9"
        },
        "currencyCode": "USD"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_4X6",
        "fileFormat": "PDF",
        "contentType": "URL",
        "contents": "https://.../cd94c4da3bf87afca7e30d4834b638.pdf"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "US_GLOBAL_NJA"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "unitWeight": {
                "weight": "0.95",
                "unitOfMeasurement": "Lb"
            },
            "itemDimension": {
                "length": "10",
                "width": "6",
                "height": "8",
                "unitOfMeasurement": "In"
            },
            "itemId": " ",
            "description": " ",
            "url": " ",
            "hSTariffCode": "610120",
            "hSTariffCodeCountry": "CA",
            "originCountryCode": "CN",
            "unitPrice": "500.00",
            "quantity": "1"
        } ]
    },
    "domesticShipmentDetails": {
        "barCodeLabelNumber": "7624003NGST0000042004Z"
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "1234-1195"
    } ],
    "parcelTrackingNumber": "PBXGA001679CC18E3199",
    "shipmentId": "PBXGA001679CC18E3199"
}

Error Codes¶

For common error codes specific to this API call, please see 13-Prefix Error Codes.

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