PB Standard Services¶
Overview¶
The PB Shipping APIs integrate with PB Standard Services through the API operations listed on this page. PB Standard labels are post-paid labels and do not incur charges at the time of print. PB Standard offers both delivery and return labels. When creating delivery labels, shippers must also containerize parcels.
This page describes how to onboard a merchant to use PB Standard; lists the API operations to use when shipping with PB Standard; and lists the supported services, special services, parcel types, and label options.
Onboard a Merchant to Print PB Standard Labels¶
If you have not yet done so, enroll the merchant with your PB developer account using one of the enrollment models described on the Merchant Accounts page. Pitney Bowes will assign the merchant a Shipper ID for use when shipping with your developer account.
Contact your Pitney Bowes representative to register the merchant at one or more PB Standard facilities. Pitney Bowes will provide the merchant with the following PB Standard IDs for use when shipping with PB Standard:
- CARRIER_FACILITY_ID
- CLIENT_FACILITY_ID
- CLIENT_ID
You can test PB Standard in the Sandbox environment by setting the IDs to the Sandbox values listed in the table below.
Email a request to ClientServicesTechSupport@pb.com asking Pitney Bowes to enable the merchant to use PB Standard. In the request, include the merchant’s PB Shipper ID and the merchant’s set of PB Standard IDs.
PB Standard IDs¶
When a merchant is set up for PB Standard services, the Pitney Bowes representative provides the merchant with three types of IDs, as listed in the table below. Use these IDs when creating a PB Standard shipment, container label, or manifest. To test PB Standard in the sandbox environment, use the ID values listed in the Sandbox Value column.
| ID |
Description |
Sandbox Value |
|---|---|---|
| CARRIER_FACILITY_ID | The PB Standard facility assigned to the merchant. A merchant can be assigned multiple PB Standard facilities. | 1585 |
| CLIENT_FACILITY_ID | The merchant’s facility. A merchant can have multiple client facility IDs. | 0093 |
| CLIENT_ID | The unique ID assigned to the merchant for use with PB Standard. | NGST |
PB Standard Facilities¶
The following are the Pitney Bowes Standard facilities.
| Facility Name
|
Facility Code (ID)
|
Facility Address
|
|---|---|---|
| ATL | 0224 | 3630 Royal South Pkwy #210, Atlanta, GA 30349 |
| ATL4 | 2035 | 3725 Royal South Pkwy, Atlanta, GA 30349 |
| BWI | 2109 | 1781 Crossroads Drive, Odenton, MD, 21113 |
| COM | 1304 | 6017 Randolph St., Commerce, CA 90040 |
| CVG | 0921 | 1200 Worldwide Blvd, Hebron, KY 41019 |
| DFW | 1361 | 1250 Mustang Drive, Grapevine, TX 76051 |
| EWR | 1779 | 117 Interstate Blvd, Monroe, NJ 08831 |
| IND | 1585 | 1415 Collins Rd, Greenwood, IN 46143 |
| MCO | 2121 | 2622 Consulate Drive Suite 100, Orlando, FL, 32819 |
| ONT | 1787 | 11260 Cedar Ave, Bloomington, CA 92316 |
| ORD | 1094 | 882 Carol Ct. Carol Stream, IL 60188 |
| PHL | 1532 | 305 Butterfly Commons, York, PA 17402 |
| RNO | 1328 | 38 Isidor Ct Suite 130, Sparks, NV 89441 |
| SCK | 2124 | 4733 Newcastle Rd. Building 3, Stockton, CA, 95215 |
| SEA | 1571 | 19005 64th Avenue South Ste 175, Kent, WA 98032 |
| SFO | 1548 | 125 Valley Drive, Brisbane, CA 94005 |
| SLC | 1712 | 2449 S 6755 W, Ste E, West Valley City, UT 84128 |
API Operations for Shipping with PB Standard¶
The following shipping operations are used with PB Standard. For requests that originate in the Asia-Pacific Region, Pitney Bowes provides APAC Services to localize operations. See APAC Services.
| Operation
|
Method | Endpoint
|
|---|---|---|
Validate an Address |
POST |
/v1/addresses/verify |
Suggest Addresses |
POST |
/v1/addresses/verify-suggest |
Rate a PB Standard Delivery Service |
POST |
/v1/rates |
Create a PB Standard Delivery Label |
POST |
/v1/shipments |
Create a PB Standard Returns Label |
POST |
/v1/shipments |
Find Facility (to print QR codes) |
POST |
/v1/carrier-facility |
Reprint a Label |
GET |
/v1/shipments/{shipmentId}?carrier={carrier} |
Retry a Label |
GET |
/v1/shipments?originalTransactionId={transaction_id}&carrier={carrier} |
Void a Label |
DELETE |
/v1/shipments/{shipmentId}?carrier={carrier}&cancelInitiator=SHIPPER |
Create a Container Label |
POST |
/v1/container-manifest |
Create a PB Standard Delivery Manifest (Closeout) |
POST |
/v1/manifests |
Get Tracking Information |
GET |
/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber&carrier=FDR |
Accounts APIs |
—— |
See the Accounts APIs table on the Merchant Accounts page. |
API Operations for APAC Services¶
For requests that originate in the Asia-Pacific Region, see APAC Services.
PB Standard Services¶
The following services are supported for PB Standard shipments created through the Shipping APIs.
| ID
|
Service
|
|---|---|
| BPM | Bound Printed Matter |
| PRCLSEL | Parcel Select, Parcel Select Return |
| PSLW | Parcel Select Lightweight |
| FCM | First-Class Mail |
| PM | Priority Mail |
PB Standard Special Services¶
The following special services are supported for PB Standard shipments created through the Shipping APIs. Do not include a special service unless you intend to apply it.
| ID | Special Service
|
Input Parameters (inputParameters) |
|---|---|---|
| DelCon | Delivery Confirmation | Input parameters are not required for DelCon. To use DelCon, add the
following to the { "specialServiceId": "DelCon" }
|
| Sig | Signature Confirmation | Input parameters are not required for Sig. To use Sig, add the following to
the { "specialServiceId": "Sig" }
|
| NOTIFICATIONS | Subscribes the shipment to provisioned notifications. Important: To use this special service, the merchant must be configured for PB Standard notifications. | To set input parameters, see the Notifications section on the PB Standard Delivery page. |
PB Standard Parcel Types¶
The following parcel type is supported for PB Standard shipments created through the Shipping APIs.
| ID | Parcel Type | Services Supporting the Parcel Type |
|---|---|---|
| PKG | Package | BPM, PRCLSEL, PSLW, FCM, PM |
PB Standard Labels¶
If you use APAC Services, this section does not apply. Please see Label Settings for APAC Services.
Before printing a PB Standard label, see the following considerations:
- The label size specified in the
documents.sizefield uses an upper-caseX. Using a lower-case x will result in an error. - If you choose to retrieve the label through a URL, the URL will be available for 24 hours.
- By default, the APIs print ZPL2 labels using the Unicode character set. If you have an older printer that does not support Unicode, see this Troubleshooting topic.
- Advise shippers on correct label placement. See What is the correct placement for a shipping label?
- For label options, see the appropriate table:
PB Standard Delivery Labels¶
The following table describes the options available for PB Standard Delivery labels. See the bulleted considerations above before printing a label. For Returns labels, see this table.
| Label Size
|
File Format
|
Content Type
|
Resolution
|
|---|---|---|---|
| DOC_4X4 | PDF PNG ZPL2 [1] |
URL BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 |
| DOC_4X5 | PDF PNG ZPL2 [1] |
URL BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 |
| DOC_4X6 | PDF PNG ZPL2 [1] |
URL BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 |
| No setting | GIF (used for QR codes only) | BASE64 | No setting |
| [1] | (1, 2, 3) If you have an older printer that does not support Unicode, see this topic. |
PB Standard Returns Labels¶
The following table describes the options available for PB Standard Returns labels. See the bulleted considerations above before printing a label. For Delivery labels, see this table.
| Label Size
|
File Format
|
Content Type
|
Resolution
|
|---|---|---|---|
| DOC_4X6 | PDF PNG |
URL BASE64 |
DPI_300 DPI_300 |
| DOC_6X4 | PDF PNG |
URL BASE64 |
DPI_300 DPI_300 |
| DOC_8X11 | URL | DPI_300 |
Shipment Options for PB Standard¶
See the Shipment Options page for options that apply to PB Standard.