Create a PB Cross-Border Delivery Service Shipment¶

HTTP Request¶

POST /v1/shipments?carrier=PBI

Summary¶

PB Cross-Border Delivery Service (CBDS) provides shipping from domestic Consolidation Centers to international destinations and uses shipper-supplied data to ensure parcels comply with international regulations prior to shipment. Invoking this API creates a post-paid CBDS shipment and provides an end-to-end tracking number.

CBDS provides outbound international shipping from the U.S. and the United Kingdom.

Prerequisites¶

The shipper must onboard with CBDS.

Testing in Sandbox¶

To test this API in Sandbox, use the Sandbox Client IDs listed on this page. You can use the Sandbox Client IDs with any Shipper ID in your Sandbox environment.

Considerations¶

The shipper’s delivery solution and first-mile option determine whether the API returns a label. The delivery solution is chosen during onboarding.

Delivery Solution and First-Mile Option	Does the API Return a Label?
End-to-End with Bulk Pickup (Available for U.S. Outbound only)	YES. The API returns a PB Standard label.
End-to-End with Piece-Level Shipment (Available for U.S. Outbound only)	YES. The API returns a USPS label.
Drop-Off to PB Standard (Available for U.S. Outbound only)	YES. The API returns the PB Standard label that Pitney Bowes will use to transport the parcel from a PB Standard facility to the CBDS Consolidation Center. The shipper is responsible for delivery to the PB Standard facility. The label for delivery to the PB Standard facility should include the following on the first address line: “Attn: PB Cross-Border”
Drop-Off to CBDS, Drop-Off to UK Hub	NO. Before invoking the API, the shipper must print a label for delivery to the CBDS Consolidation Center. The shipper supplies the label’s tracking number when invoking the API. Note Failure to provide the tracking number will result in the parcel being unrecognized at the Consolidation Center.

The fromAddress, toAddress, and altReturnAddress objects require the following fields:
- addressLines
- cityTown
- stateProvince. Required for Canadian addresses. Use the 2-letter province code.
- postalCode
- countryCode
- name
If the first-mile option is Drop-Off to PB Standard, enter “Attn: PB Cross-Border” in line 1 of the toAddress.
The supported service classes depend on the country of origin (as shown below), the shipping lane, and the merchant’s delivery agreement.

U.S. outbound supports the following service classes:
- PBXPS: Standard DDP
- PBXUS: Standard DDU
- PBXPE: Expedited DDP
UK outbound supports the following service class:
- PBXPS: Standard DDP
Do not pass a special service in the request. If you do, the service will be ignored. Note that the response might return the DelCon special service, which is a no-charge service.

In the shipmentOptions array, set the following options, depending on the delivery solution and first-mile option:

Shipment Option	Required for:
SHIPPER_ID	All delivery solutions
CLIENT_ID	All delivery solutions
CLIENT_FACILITY_ID	End-to-End with Bulk Pickup, Drop-Off to PB Standard
CARRIER_FACILITY_ID	End-to-End with Bulk Pickup, Drop-Off to PB Standard, Drop-Off to CBDS

The customs.customsInfo object requires the currencyCode field. For U.S. outbound, set currencyCode to USD. For UK outbound, set currencyCode to GBP.

The API does not use the other fields in the customs.customsInfo object. If you pass them, they will be ignored.

In the customs.customsItems array’s description field, provide as much detail as possible about the item and brand in order to facilitate assignment of the correct HS code. See the following examples:

"description": "Acme AC8431 Rechargeable Hand Blender with Electric Attachments"

"description": "Antique Vintage Victorian Edwardian Walnut Writing Stationery Box"

"description": "Pitney Bowes 793-5 Fluorescent Red Ink Cartridge DM100 DM200"

If shipping a HAZMAT-flagged item, enter the applicable HAZMAT classifications in the customs.customsItems array’s hazmats field. See How Does CBDS Handle HAZMAT-flagged Items?
If using the Drop-Off to CBDS first-mile option, pass the first-mile label’s tracking number through the domesticShipmentDetails object.

Important

Failure to provide the tracking number will result in the parcel being unrecognized at the CBDS Consolidation Center.
The API response returns:
- The estimated charges, which include the Transportation cost and, if applicable, the Importation costs.
- The tracking number for the parcel’s full journey, from the origin address to the international destination.
- The first-mile label if the delivery solution returns a label. For whether the delivery solution returns a label, see Delivery Solutions above.
If the API returns the first-mile label, the label must be used within 25 days.

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

Query Parameter¶

Name

Description

carrier

Required. Set this to PBI.

includeDeliveryCommitment

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

Valid values:

true
false

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.
X-PB-UnifiedErrorStructure	Recommended. Set this to `true` to use the standard error object if an error occurs.

Request / Response Elements¶

The API call sends and receives a Shipment Object. The table below describes all possible fields in a Shipment Object.

Important

Some fields in the Shipment Object do not apply to this operation.

Name	Data Type	Description
fromAddress	Address Object	Required. Origin address. If you want a different address to appear on the label from the one listed here, see How do I print a return address that is different from the origin address?
toAddress	Address Object	Required. Destination address. FedEx, UPS: If you are shipping with FedEx or UPS to Puerto Rico or an international destination, and if the importer is different from the final recipient, this is the address of the importer. Enter the recipient’s address in the `soldToAddress` object. If importer’s address is the same as the final recipient, the `toAddress` and `soldToAddress` must match.
altReturnAddress	Address Object	PB Expedited, CBDS Only. Applies as follows: PB Expedited: If you are sending an international shipment and if you have set the NON_DELIVERY_OPTION shipment option to `redirect`, then enter the address that a returned parcel should go to. CBDS: For a Create Shipment request, this is the address used to return a parcel from the CBDS Consolidation Center. If omitted, the `fromAddress` is used. The `altReturnAddress` is not returned in the response.
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]	Conditional. 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 is required, except in the following cases: This field does not apply to Rate Parcel requests. This field does not apply to the Create CBDS Shipment request if the merchant prints the first-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	Conditional. For shipments that use customs forms, this object contains the customs information. This field is required for the following carriers 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. When using the Customs Info Object, make sure to include the fields marked Required.
customs.customsItems	Array[Customs Items Object]	Customs clearance information for each commodity. When using the Customs Items Object, make sure to include the fields marked Required. The maximum number of objects in this array is 30.
domesticShipmentDetails	Domestic Shipment Details Object	CBDS Only. Required if the merchant prints the first-mile label prior to invoking the Create CBDS Shipment API. This object contains information about the first-mile leg of the shipment.
soldToAddress	Address Object	FedEx, UPS Only. The final recipient of a the shipment. Required for a shipment from the U.S. to Puerto Rico or to an international destination. 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.
shipmentType	String	Return Labels Only. Set this to `RETURN`. Required for Rate Expedited Returns, Create Expedited Returns, and Create Standard Returns. Note: You cannot rate Standard Returns.
references	Array[Object]	PB Standard, CBDS Only. Conditional. The merchant’s reference fields. Each object in the array includes a name-value pair that defines a reference field. This array applies only to the following two carriers: PB Standard: The array is optional. See PB Standard References. CBDS: The array is required for specific delivery solutions. See References Array in a CBDS Shipment. To pass references for carriers other than the above, see Reference Fields.
references.name	String	PB Standard, CBDS Only. The name of the reference field.
references.value	String	PB Standard, CBDS Only. The value for the reference field.
hazmatDetails	Hazmat Details Object	PB Standard Only. If shipping hazardous materials with PB Standard, use this 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.

Categories Object¶

Use the customs.customsItems.categories array only if the merchant has provided Pitney Bowes a category tree. Otherwise, do not use the array. The array takes an object with the fields described below. For examples of the categories array, see the Sample Requests further down on this page.

Name	Data Type	Description
categoryCode	String	Required. The item’s category identifier based on the product categories agreed on with Pitney Bowes. The maximum length is 50 characters.
parentCategoryCode	String	Parent category of the item’s category identifier, based on the merchant product categories agreed on with Pitney Bowes. Maximum 50 characters.
descriptions	Array[Object]	The description of the category. You can include multiple objects for descriptions in multiple languages.
descriptions.locale	String	The language used for the category description. For example, `en_US`. The maximum length is 10 characters. This field is required by the `descriptions` array.
descriptions.name	String	The category description. The maximum length is 255 characters. This field is required by the `descriptions` array.
descriptions.parentsNames	Array[String(255)]	The tree of parent names to reach this category. `parentNames[0]` must be the top-level name, and `parentNames[Max Length-1]` must be the name of the parent category containing this category. Maximum 255 characters.
categoryNamePath	String	Hierarchical path to the category represented by the category name of each level, concatenated with a pipe (`\|`) delimiter. For example: CONSUMABLES AND GROCERY\|BABY\|BABY CARE\|BABY CONSUMABLES\|BABY FOOD
categoryCodePath	String	Hierarchical path to the category represented by the category ID of each level, concatenated with a colon delimiter. For example: 9785:8266:9798:9799:10203
categorySiteId	String	The category site ID if the eBay category is referred.

Domestic Shipment Details Object¶

Use the domesticShipmentDetails object when using the Drop-Off to CBDS first-mile option. The object passes the first-mile label’s tracking number, as shown in the following example for a US Outbound shipment:

"domesticShipmentDetails": {
    "shipperTrackingNumber": "USPS13600150468398",
    "carrier": "USPS"
}

The object takes the following fields:

Name

Data Type

Description

shipperTrackingNumber

String

Required. The tracking number for the domestic leg of the shipment.

carrier

String

The carrier for the domestic leg of the shipment. If you are using one of the following carriers, enter them as follows:

USPS
DHL: DHL Express
FedEx
UPS

dcAddress

Address Object

The origin address for the domestic leg of the shipment. The parcel is shipped from this address to the CBDS Consolidation Center.

References Array in a CBDS Shipment¶

Use the references array to pass shipper-generated references. Pitney Bowes includes the values in tracking files and invoices. Each object in the array contains a name-value pair that defines a reference field, as shown here:

"references": [ {
    "name": "ORDER_NUMBER",
    "value": "<order_ID>"
},{
    "name": "ReferenceNumber",
    "value": "<ref_number>"
} ]

The array is recommended for all delivery solutions and first-mile options but is required as shown in the table below. The array defines the following reference fields:

Name

Value

Required for these First-Mile Options

ORDER_NUMBER

The shipper-generated order ID.

End-to-End with Bulk Pickup
End-to-End with Piece-Level Shipment
Drop-Off to PB Standard

ReferenceNumber

The shipper-generated reference number.

End-to-End with Bulk Pickup
Drop-Off to PB Standard

Sample Requests¶

See the following sample requests for the following delivery solution and first-mile options:

For these options:	See this example:
End-to-End with Bulk Pickup Drop-Off to PB Standard	Sample Request to Return a PB Standard Label
End-to-End with Piece-Level Shipment	Sample Request to Return a USPS Label
Drop-Off to CBDS	Sample Request for Drop-Off to CBDS (U.S. Outbound)
Drop-Off to UK Hub	Sample Request for Drop-Off to CBDS (UK Outbound)

Sample Request to Return a PB Standard Label¶

The following request is used for the End-to-End with Bulk Pickup option and for the Drop-Off to PB Standard option. For a sample label, see the sample label below, after the request and response.

Sample Request to Return a PB Standard Label¶

curl -X POST .../v1/shipments?carrier=PBI&includeDeliveryCommitment=false \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <unique_transaction_id>" \
-d '
{
    "fromAddress": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "unitOfMeasurement": "in",
            "length": "2.15",
            "width": "2",
            "height": "3",
            "irregularParcelGirth": "2"
        },
        "weight": {
            "unitOfMeasurement": "Lb",
            "weight": "2"
        }
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_4X6",
        "fileFormat": "PDF",
        "contentType": "URL",
        "printDialogOption": "EMBED_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    },{
        "name": "CLIENT_FACILITY_ID",
        "value": "2067"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "0921"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "description": "Sample Items Acme AC8431 Rechargeable Hand Blender with Electric Attachments",
            "quantity": 1,
            "unitPrice": 164,
            "unitWeight": {
                "weight": 2,
                "unitOfMeasurement": "Lb"
            },
            "hSTariffCode": "0",
            "originCountryCode": "MX",
            "url": "http://example.com/blender",
            "itemId": "85-SKU",
            "hSTariffCodeCountry": "US"
          } ]
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    },{
        "name": "ReferenceNumber",
        "value": "321789"
    } ]
}'

Sample Response to Return a PB Standard Label¶

{
    "fromAddress": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "length": 2.15,
            "height": 3,
            "width": 2,
            "unitOfMeasurement": "in",
            "irregularParcelGirth": "2"
        },
        "weight": {
            "weight": 2,
            "unitOfMeasurement": "Lb"
        },
        "valueOfGoods": 164.0
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG",
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "0"
            } ]
        } ],
        "baseCharge": 21.14,
         "totalCarrierCharge": 29.34,
         "currencyCode": "USD",
         "totalTaxAmount": 8.20
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_4X6",
        "fileFormat": "PDF",
        "contentType": "URL",
        "contents": "https://.../4d864381fb1a4c8ba678e2e8d867abcd.pdf"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    },{
        "name": "CLIENT_FACILITY_ID",
        "value": "2067"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "0921"
    },{
        "name": "PRINT_CUSTOM_MESSAGE_2",
        "value": "UPPBX0016FF5B249E826"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "itemId": "85-SKU",
            "description": "Sample Items Acme AC8431 Rechargeable Hand Blender with Electric Attachments",
            "quantity": 1,
            "unitPrice": 164.00,
            "url": "http://example.com/blender",
            "unitWeight": {
                "weight": 2,
                "unitOfMeasurement": "Lb"
            },
            "originCountryCode": "MX",
            "hSTariffCode": "0",
            "hSTariffCodeCountry": "US"
        } ]
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    },{
        "name": "ReferenceNumber",
        "value": "321789"
    } ],
    "parcelTrackingNumber": "UPPBX0016FF5B249E826",
    "shipmentId": "UPPBX0016FF5B249E826"
}

Sample PB Standard Label

The following is a sample PB Standard label, which is returned for the following first-mile options: End-to-End with Bulk Pickup, and Drop-Off to PB Standard.

Sample Request to Return a USPS Label¶

The following is a sample request for the End-to-End with Piece-Level Shipment first-mile option. The request returns a USPS label, as shown below after the sample response.

Sample Request for End-to-End with Piece-Level Shipment¶

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": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "length": "12",
            "width": "5",
            "height": "10",
            "unitOfMeasurement": "IN"
        },
        "weight": {
            "weight": 80,
            "unitOfMeasurement": "OZ"
        }
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "contentType": "URL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "resolution": "DPI_203",
        "printDialogOption": "EMBED_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "USPSFM_1"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "categories": [ {
                "categoryCode": "10203",
                "categoryNamePath": "WOMEN|CLOTHING|DRESSES|FLORAL"
            } ],
            "description": "vintage floral-print patchwork long-sleeve cotton linen dress with pockets",
            "hSTariffCode": "610442",
            "hSTariffCodeCountry": "US",
            "itemId": "54378DRE",
            "quantity": 2,
            "unitPrice": 100.00,
            "url": "http://www.example.com/shop/women/clothing/dress/54378DRE"
        } ]
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    } ]
}'

Sample Response for End-to-End with Piece-Level Shipment¶

{
    "fromAddress": { ... },
    "toAddress": { ... },
    "parcel": {
        "dimension": {
            "length": 12,
            "height": 10,
            "width": 5,
            "unitOfMeasurement": "IN"
        },
        "weight": {
            "weight": 80,
            "unitOfMeasurement": "OZ"
        },
        "valueOfGoods": 200.0
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG",
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "0"
            } ],
            "fee": 0.00
        } ],
        "inductionPostalCode": "36830",
        "dimensionalWeight": {
            "weight": 0.0,
            "unitOfMeasurement": "OZ"
        },
        "baseCharge": 42.22,
        "totalCarrierCharge": 89.87,
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "5",
            "maxEstimatedNumberOfDays": "8"
        },
        "currencyCode": "USD",
        "destinationZone": 4,
        "totalDutyAmount": 16.20,
        "totalTaxAmount": 31.45
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "contentType": "URL",
        "contents": "https://.../usps/325584758/outbound/label/9d1da50f82734ab9d4a41d5ffb9a19b.pdf"
        }
    ],
    "shipmentOptions": [ {
        "name": "HIDE_TOTAL_CARRIER_CHARGE",
        "value": "false"
    },{
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "ADD_TO_MANIFEST",
        "value": "false"
    },{
        "name": "FUTURE_SHIPMENT_DATE",
        "value": "2020-10-06 16:35:26.327"
    },{
        "name": "MINIMAL_ADDRESS_VALIDATION",
        "value": "false"
    },{
        "name": "SHIPPING_LABEL_RECEIPT",
        "value": "noOptions"
    },{
        "name": "PRINT_CUSTOM_MESSAGE_2",
        "value": "UPPBX0015B2A0E60EF73"
    },{
        "name": "CLIENT_ID",
        "value": "UP3456"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "itemId": "54378DRE",
            "description": "vintage floral-print patchwork long-sleeve cotton linen dress with pockets",
            "quantity": 2,
            "unitPrice": 100.00,
            "url": "http://www.example.com/shop/women/clothing/dress/54378DRE",
            "categories": [ {
                "categoryCode": "10203",
                "categoryNamePath": "WOMEN|CLOTHING|DRESSES|FLORAL",
                "categoryCodePath": "9785:8266:9798:9799:10203"
            } ],
            "hSTariffCode": "610442",
            "hSTariffCodeCountry": "US"
        } ]
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    } ],
    "parcelTrackingNumber": "SBXCZ000000002135402",
    "shipmentId": "SBXCZ000000002135402"
}

Sample Label for End-to-End with Piece-Level Shipment

The following is a sample USPS label returned for the End-to-End with Piece-Level Shipment option.

Sample Request for Drop-Off to CBDS (U.S. Outbound)¶

The following is a sample request for the Drop-Off to CBDS first-mile option. You must print the first-mile label prior to the API call. When making the API call, you must pass the label’s tracking number through the domesticShipmentDetails object.

The request does not return a label.

Sample Request for Drop-Off to CBDS¶

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": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "length": "16",
            "width": "12",
            "height": "2",
            "unitOfMeasurement": "IN"
        },
        "weight": {
            "weight": 24,
            "unitOfMeasurement": "OZ"
        }
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "COFM_1"
    },{
        "name": "CLIENT_FACILITY_ID",
        "value": "0093"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "US_ELOVATIONS_KY"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "description": "clothing men's shirt casual button-down slim fit cotton wrinkle-free single-needle construction",
            "hSTariffCode": "6205200010",
            "hSTariffCodeCountry": "CA",
            "itemId": "43953AE0",
            "quantity": 1,
            "unitPrice": 45.00,
            "url": "http://www.example.com/shop/43953AE0"
        } ]
    },
    "domesticShipmentDetails": {
        "shipperTrackingNumber": "USPS13600150468398",
        "carrier": "USPS"
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    } ]
}'

Sample Response for Drop-Off to CBDS¶

{
    "fromAddress": { ... },
    "toAddress": { ... },
    "parcel": {
        "dimension": {
            "length": 16,
            "height": 2,
            "width": 12,
            "unitOfMeasurement": "IN"
        },
        "weight": {
            "weight": 24,
            "unitOfMeasurement": "OZ"
        },
        "valueOfGoods": 125.00
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG",
        "baseCharge": 41.38,
        "totalCarrierCharge": 49.69,
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "6",
            "maxEstimatedNumberOfDays": "9"
        },
        "currencyCode": "USD",
        "totalTaxAmount": 8.31
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "COFM_1"
    },{
        "name": "CLIENT_FACILITY_ID",
        "value": "0093"
    },{
        "name": "CARRIER_FACILITY_ID",
        "value": "US_ELOVATIONS_KY"
    } ],
    "customs": {
        "customsInfo": {
            "currencyCode": "USD"
        },
        "customsItems": [ {
            "itemId": "43953AE0",
            "description": "clothing men's shirt casual button-down slim fit cotton wrinkle-free single-needle construction",
            "quantity": 1,
            "unitPrice": 45.00,
            "url": "http://www.example.com/shop/43953AE0",
            "hSTariffCode": "6205200010",
            "hSTariffCodeCountry": "CA"
        } ]
    },
    "domesticShipmentDetails": {
        "carrier": "USPS",
        "shipperTrackingNumber": "USPS13600150468398"
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "123456"
    } ],
    "parcelTrackingNumber": "SBXCZ000000002140172",
    "shipmentId": "SBXCZ000000002140172"
}

Sample Request for Drop-Off to CBDS (UK Outbound)¶

The following is a sample request for the Client Drop-Off Solution for UK Outbound. You must print the first-mile label prior to the API call and pass the label’s tracking number through the domesticShipmentDetails object. The request does not return a label.

Sample Request for Drop-Off to CBDS (UK Outbound)¶

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": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "length": "6",
            "width": "8",
            "height": "9",
            "unitOfMeasurement": "IN",
            "irregularParcelGirth": "0.0"
        },
        "weight": {
            "unitOfMeasurement": "LB",
            "weight": "15"
        },
    },
    "customs": {
        "customsInfo": {
           "currencyCode": "GBP"
        },
        "customsItems": [ {
            "itemId": "880682",
            "description": "clothing men's shirt casual button-down slim fit cotton wrinkle-free single-needle construction",
            "quantity": "2",
            "unitPrice": "400.88",
            "url": "http://www.example.com/uk/shop/880682",
            "hSTariffCode": "620120",
            "hSTariffCodeCountry": "US",
            "originCountryCode": "GB"
        } ]
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG"
    } ],
    "domesticShipmentDetails": {
        "shipperTrackingNumber":"USPS-8470170391",
        "carrier": "FEDEX",
        "dcAddress": { ... }
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "MerchantOrder-2583"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "contentType": "URL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "printDialogOption": "EMBED_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "CBDS_0044"
    } ]
}'

Sample Response for Drop-Off to CBDS (UK Outbound)¶

{
    "fromAddress": { ... },
    "toAddress": { ... },
    "altReturnAddress": { ... },
    "parcel": {
        "dimension": {
            "length": 6,
            "height": 9,
            "width": 8,
            "unitOfMeasurement": "IN"
        },
        "weight": {
            "weight": 15,
            "unitOfMeasurement": "LB"
        },
        "valueOfGoods": 200.0
    },
    "customs": {
        "customsInfo": {
           "currencyCode": "GBP"
        },
        "customsItems": [ {
            "itemId": "880682",
            "description": "clothing men's shirt casual button-down slim fit cotton wrinkle-free single-needle construction",
            "quantity": "2",
            "unitPrice": "400.88",
            "url": "http://www.example.com/uk/shop/880682",
            "hSTariffCode": "620120",
            "hSTariffCodeCountry": "US",
            "originCountryCode": "GB"
        } ]
    },
    "rates": [ {
        "carrier": "PBI",
        "serviceId": "PBXPS",
        "parcelType": "PKG"
        "baseCharge": 15.76,
        "totalCarrierCharge": 221.12,
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "4",
            "maxEstimatedNumberOfDays": "8"
         },
         "currencyCode": "GBP",
         "totalDutyAmount": 110.88,
         "totalTaxAmount": 94.48
    } ],
    "domesticShipmentDetails": {
        "shipperTrackingNumber":"USPS-8470170391",
        "carrier": "FEDEX",
        "dcAddress": { ... }
    },
    "references": [ {
        "name": "ORDER_NUMBER",
        "value": "MerchantOrder-2583"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "contentType": "URL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "printDialogOption": "EMBED_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "CBDS_0044"
    } ],
    "parcelTrackingNumber": "PBXAA000000010030065",
    "shipmentId": "PBXAA000000010030065"
}

Error Codes¶

For common error codes specific to this API call, please see 130####.

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