Pitney Bowes¶
On this page
Overview¶
Pitney Bowes provides delivery and return shipping through PB Expedited (USPS
) and PB Standard (PBCS
), as described in the table below. When writing your code, you can write one Create Shipment request that integrates to both PB Expedited and PB Standard, providing merchants the full range of shipping options.
Carrier |
ID |
Description |
---|---|---|
PB Expedited |
|
PB Expedited provides domestic and international shipping through USPS®. PB Expedited offers both delivery and return labels. On qualifying shipments, PB Expedited offers PB Delivery Guarantee. By default, all developer and merchant accounts have access to ship with PB Expedited. The carrier ID for PB Expedited is |
PB Standard |
|
PB Standard provides postpaid shipping. Labels incur no charges at the time of print. PB Standard offers both delivery and return labels. When printing PB Standard delivery labels, shippers must containerize parcels. To ship with PB Standard, a merchant must first onboard. The carrier ID for PB Standard is |
API Operations¶
PB Expedited and PB Standard use the following operations. For an operational sequence, see the Shipping Workflow. In addition to the operations here, Pitney Bowes provides APAC Services for PB Standard requests that originate in the Asia-Pacific Region.
Operation |
Method |
Resource Path |
---|---|---|
GET |
/v1/information/rules/rating-services?carrier={carrier}&originCountryCode={XX}&destinationCountryCode={YY} |
|
GET |
/v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code} |
|
POST |
/v1/carrier-facility |
|
POST |
/v1/addresses/verify |
|
POST |
/v1/addresses/verify-suggest |
|
POST |
/v1/rates |
|
POST |
/v1/shipments |
|
POST |
/v1/shipments |
|
POST |
/v1/shipments |
|
POST |
/v1/shipments |
|
GET |
/v1/shipments/{shipmentId}?carrier={carrier} |
|
GET |
/v1/shipments?originalTransactionId={transaction_id}&carrier={carrier} |
|
DELETE |
/v1/shipments/{shipmentId}?carrier={carrier}&cancelInitiator=SHIPPER |
|
POST |
/v1/shipments/{shipmentId}/email |
|
POST |
/v1/manifests |
|
POST |
/v1/manifests |
|
POST |
/v1/container-manifest |
|
GET |
/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber |
|
GET |
/v4/ledger/developers/{developerId}/transactions/reports |
|
GET |
/v4/ledger/developers/{developerId}/transactions/archived |
|
—— |
Services (Mail Classes)¶
Pitney Bowes provides Delivery Services, Returns Services, and International Services.
Delivery Services¶
The following table does not show whether a special service is compatible with a given combination of service and parcel type. If your shipment uses PB Expedited, you can check compatibility using the Rules API or Domestic Mail Manual. Note that some domestic services might include a customs form, as described in this FAQ.
Delivery Mail Class |
ID |
PB Expedited
|
PB Standard
|
Parcel Types 1 |
---|---|---|---|---|
Bound Printed Matter |
BPM |
✓ |
PKG |
|
First-Class Mail |
FCM |
✓ |
✓ |
Expedited: FLAT, IRRPKG, LETTER, NMLETTER, PKG
|
Library Mail |
LIB |
✓ |
LGENV, PKG |
|
Media Mail |
MEDIA |
✓ |
LGENV, PKG |
|
Parcel Select |
PRCLSEL |
✓ |
PKG |
|
Parcel Select Ground |
PRCLSEL |
✓ |
PKG |
|
Parcel Select Lightweight |
PSLW |
✓ |
PKG |
|
Priority Mail |
PM |
✓ |
✓ |
Expedited: FRB, FRE, LGENV, LFRB, LGLFRENV, MLFRB, PKG, PFRENV, SOFTPACK, SFRB
|
Priority Mail Express |
EM |
✓ |
FRE, LGENV, LGLFRENV, PKG, PFRENV |
|
Retail Ground (formerly Standard Post) |
STDPOST |
✓ |
PKG |
Returns Services¶
The following table does not show whether a special service is compatible with a given combination of service and parcel type. If your shipment uses PB Expedited, you can check compatibility using the Rules API or Domestic Mail Manual.
Returns Mail Class |
ID |
PB Expedited
|
PB Standard
|
Parcel Types 2 |
---|---|---|---|---|
First-Class Package Return Service |
FCM |
✓ |
PKG |
|
Parcel Select Return Service |
PRCLSEL |
✓ |
✓ |
PKG |
Priority Mail Return Service |
PM |
✓ |
PKG, FRE, LGLFRENV, PFRENV |
International Services¶
The returned label includes the customs form. The following table shows supported services and parcel types but does not show whether a special service is compatible with a given combination of service and parcel type. To check compatibility, use the Rules API or Domestic Mail Manual.
International Mail Class |
ID |
Parcel Types 3 |
---|---|---|
First-Class Mail International |
FCMI |
LGENV, LTR, NMLTR |
First-Class Package International Service
|
FCPIS |
PKG |
Priority Mail Express International |
EMI |
FRE, LGENV, LGLFRENV, PFRENV, PKG |
Priority Mail International |
PMI |
DVDBOX, FRB, FRE, LFRB, LGENV, LGLFRENV, PFRENV, PKG, SFRB, VIDEOBOX |
Special Services¶
This section describes the following:
PB Expedited Special Services¶
PB Expedited supports the following special services. Before using a special service, use the Rules API to determine:
If the special service is compatible with the combination of mail class and parcel type.
If the mail class and parcel type require a trackable special service. If so,
DelCon
is trackable and has no charge.If the special service is compatible with other special services.
What are the input parameters. For more info on input parameters, see this FAQ.
Important
This table does not show compatible parcel types.
This table does not show compatibility with other special services.
Use of a special service might be subject to other restrictions.
Do not include a special service unless you intend to apply it.
Note
If you use the FCM service, no special service is required.
Special Service |
ID |
Services 4 |
---|---|---|
Adult Signature Required |
ADSIG |
EM, FCM, PM, PRCLSEL |
Adult Signature with Restricted Delivery |
ADSIGRD |
EM, FCM, PM, PRCLSEL |
Certified Mail |
Cert |
FCM, PM |
Certified Mail with Adult Signature |
CERTAD |
FCM, PM |
Certified Mail with Adult Signature and Restricted Delivery |
CERTADRD |
FCM, PM |
Certified Mail with Restricted Delivery |
CertRD |
FCM, PM |
Collect On Delivery (COD) |
COD |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Collect On Delivery with Restricted Delivery |
CODRD |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Delivery Confirmation |
DelCon |
FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Electronic Return Receipt |
ERR |
FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Hazardous Materials |
hazmat |
EM, FCM, PM, PRCLSEL, STDPOST |
Hazardous Materials Restricted Electronic Device |
hazmat-electronics |
PRCLSEL, STDPOST |
Holiday Delivery. |
holiday |
EM |
Insured Mail |
Ins |
EM, EMI, FCM, LIB, MEDIA, PM, PMI, PRCLSEL, STDPOST |
Insured Mail with Restricted Delivery |
InsRD |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Live Animal |
liveanimal |
EM, FCM, PM, PRCLSEL, STDPOST |
Live Animal - Day Old Poultry |
liveanimal-poultry |
EM, FCM, PM, PRCLSEL, STDPOST |
Registered Mail |
Reg |
FCM, PM |
Registered Mail with COD |
RegCOD |
FCM, PM |
Registered Mail with Insurance |
RegIns |
FCM, PM |
Registered Mail with Insurance and Restricted Delivery |
RegInsRD |
FCM, PM |
Registered Mail with Restricted Delivery |
RegRD |
FCM, PM |
Return Receipt |
RR |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Special Handling - Fragile |
SH |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Signature Confirmation |
Sig |
EM, FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Signature with Restricted Delivery |
SigRD |
FCM, LIB, MEDIA, PM, PRCLSEL, STDPOST |
Sunday Delivery |
sunday |
EM |
Sunday holiday Delivery |
sunday-holiday |
EM |
PB Expedited Special Services Returned Only in the Response¶
The following special services can be returned in the response of a Create Shipment request. They provide information about fees, if applicable.
Special Service |
ID |
Description |
---|---|---|
Non-Standard Dimension 1 |
NonStandardDim1 |
Applies if length is greater than 22 inches and less than or equal to 30 inches. |
Non-Standard Dimension 2 |
NonStandardDim2 |
Applies if the length is greater than 30 inches. |
Non-Standard Volume |
NonStandardVol |
Applies if volume is greater than 2 cubic feet. |
PB Standard Special Services¶
The following special services are supported for PB Standard shipments created through the Global Ecommerce APIs. Do not include a special service unless you intend to apply it.
Special Service |
ID |
Input Parameters |
---|---|---|
Delivery Confirmation |
DelCon |
Input parameters are not required for DelCon. To use DelCon, add the following to the { "specialServiceId": "DelCon" }
|
Signature Confirmation |
Sig |
Input parameters are not required for Sig. To use Sig, add the following to the { "specialServiceId": "Sig" }
|
Subscribe to Notifications |
NOTIFICATIONS |
To set input parameters, see PB Standard Notifications. Note: To use this service, the merchant must be configured for notifications, as described in PB Standard Notifications. |
Parcel Types¶
Pitney Bowes supports the parcel types described in the following tables:
PB Expedited Letters and Flats¶
Parcel Type |
ID |
Services that use the Parcel Type 5 |
---|---|---|
Large Envelope/Flat |
Use one of the following IDs, depending on the mail class: LGENV: Use for mail classes other than First-Class. FLAT: Use only with First-Class Mail. FLAT requires the DOC_6X4 label size. FLAT does not support special services. The generated label has an IMb. See this FAQ on printing an IMb label. |
The services (mail classes) are specific to the ID: LGENV supports EM, EMI, FCMI, LIB, MEDIA, PM, and PMI FLAT supports FCM |
Flat Rate Envelope |
FRE |
EM, EMI, PM, PMI |
Letter |
LETTER Use only with First-Class Mail and a label size of either DOC_6X4 or DOC_9X4. LETTER does not support special services. The generated label has an IMb. See this FAQ on printing an IMb label. |
FCM |
Legal Flat Rate Envelope |
LGLFRENV |
EM, EMI, PM, PMI |
Letter |
LTR Use only with First-Class Mail International (FCMI). |
FCMI |
NMLETTER Use only with First-Class Mail. For steps to ship non-machinable letters, see this FAQ. |
FCM |
|
NMLTR Use only with First-Class Mail International (FCMI). For steps to ship non-machinable letters, see this FAQ. |
FCMI |
|
Padded Flat Rate Envelope |
PFRENV |
EM, EMI, PM, PMI |
Soft Pack Envelope |
SOFTPACK |
PM |
PB Expedited Packages¶
Parcel Type |
ID |
Services that use the Parcel Type 6 |
---|---|---|
DVD Flat Rate Box |
DVDBOX |
PMI |
Medium Flat Rate Box 1,
|
FRB |
PM, PMI |
For steps to ship irregular parcels, please see this FAQ. |
IRRPKG |
FCM |
Large Flat Rate Box |
LFRB |
PM, PMI |
Military Large Flat Rate Box |
MLFRB |
PM |
Package |
PKG |
EM, EMI, FCM, FCPIS, LIB, MEDIA, PM, PMI, PRCLSEL, STDPOST |
Small Flat Rate Box |
SFRB |
PM, PMI |
Large Video Flat Rate Box |
VIDEOBOX |
PMI |
PB Standard Packages¶
PB Standard uses the Package (PKG) parcel type.
Parcel Type |
ID |
Services Supporting the Parcel Type |
---|---|---|
Package |
PKG |
BPM, PRCLSEL, PSLW, FCM, PM |
Labels¶
Label Considerations¶
The value for the label size uses an uppercase
X
. Do not use a lowercase x.For
FCM
/FLAT
shipments, set the label size toDOC_6X4
.For
FCM
/LETTER
shipments, set the label size toDOC_6X4
orDOC_9X4
.For shipments that use the
customs
object, set the label size toDOC_4X6
orDOC_8X11
. The returned label includes the customs form. The form serves as both shipping label and customs declaration. For more information, see these FAQs.To print Doc Tabs, see this FAQ.
For ZPL2 labels, if your printer does not support Unicode, see this topic.
The PB Standard Returns service provides the option to create a QR code instead of a label.
Labels retrieved through URLs are available for 24 hours after creation.
Advise shippers on correct label placement.
For APAC Services, see APAC Label Settings.
Label Sizes Per Carrier¶
Pitney Bowes supports the following label sizes. For the label options for each carrier, see these tables: Expedited Delivery Labels, Standard Delivery Labels, and Standard Returns Labels.
Label size |
PB Expedited Delivery
|
PB Standard Delivery
|
PB Standard Returns
|
---|---|---|---|
DOC_4X4 |
✓ |
||
DOC_4X5 |
✓ |
||
DOC_4X6 |
✓ |
✓ |
✓ |
DOC_4X8 |
✓ |
||
DOC_6X4 |
✓ |
✓ |
|
DOC_8X11 |
✓ |
✓ |
|
DOC_9X4 |
✓ |
Expedited Delivery Labels¶
Note
Please read the Label Considerations above before printing a label.
PB Expedited Delivery labels use the following options.
Label Size |
File Format |
Content Type |
Resolution |
---|---|---|---|
DOC_4X6 |
PNG ZPL2 |
URL BASE64 BASE64 |
not applicable DPI_203, DPI_300 (default) DPI_203 (default), DPI_300 (domestic labels only) |
DOC_4X8 |
PNG ZPL2 |
URL BASE64 BASE64 |
not applicable not applicable not applicable |
DOC_6X4 |
PNG ZPL2 |
URL BASE64 BASE64 |
not applicable DPI_203 DPI_203 |
DOC_8X11 |
PNG |
URL BASE64 |
not applicable DPI_300 |
DOC_9X4 |
PNG |
URL BASE64 |
not applicable DPI_203 |
Standard Delivery Labels¶
Note
Please read the Label Considerations above before printing a label.
PB Standard Delivery labels use the following options.
Label Size |
File Format |
Content Type |
Resolution |
---|---|---|---|
DOC_4X4 |
PNG ZPL2 |
URL BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 |
DOC_4X5 |
PNG ZPL2 TIF BMP |
URL BASE64 BASE64 BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 DPI_203, DPI_300, DPI_600 (default) DPI_203, DPI_300, DPI_600 (default) |
DOC_4X6 |
PNG ZPL2 BMP |
URL BASE64 BASE64 BASE64 |
DPI_203 DPI_203 DPI_203 (default), DPI_300 DPI_203, DPI_300, DPI_600 (default) |
Standard Returns Labels¶
Note
Please read the Label Considerations above before printing a label.
PB Standard Returns labels use the following options:
Label Size |
File Format |
Content Type |
Resolution |
---|---|---|---|
DOC_4X6 |
PNG ZPL2 |
URL BASE64 BASE64 |
DPI_300 DPI_203, DPI_300 (default) DPI_203, DPI_300 (default) |
DOC_6X4 |
PNG ZPL2 |
URL BASE64 BASE64 |
DPI_300 DPI_203, DPI_300 (default) DPI_203, DPI_300 (default) |
DOC_8X11 |
URL |
DPI_300 |
Standard Returns QR Codes¶
PB Standard Returns QR codes use the following options:
File Format |
Content Type |
---|---|
GIF |
URL BASE64 |
Surcharges¶
For PB Expedited, the following USPS surcharges can apply. If a surcharge applies, it is returned in the rates.surcharges
array.
API Code |
Surcharge |
---|---|
irregular |
The parcel is an Irregular Parcel. |
nonmachinable |
The parcel is a Nonmachinable Letter. |
Oversize |
The parcel is subject to oversize pricing. Note: If the |
Onboard with PB Standard¶
To onboard a merchant to use PB Standard:
Contact your Pitney Bowes representative to register the merchant at one or more PB Standard facilities. Pitney Bowes will provide the merchant with a set of PB Standard IDs for use when shipping with PB Standard.
Email a request to ClientSupportTechServices@pb.com asking Pitney Bowes to enable the merchant to use PB Standard. In the request, include the merchant’s Shipper ID and PB Standard IDs.
PB Standard IDs¶
Pitney Bowes provides a merchant with the following IDs during onboarding. Pitney Bowes also provides test values for the IDs for use when testing on Sandbox.
ID |
Description |
Sandbox Test Value |
---|---|---|
CLIENT_ID |
The unique ID assigned to the merchant for use with PB Standard. |
NGST |
CLIENT_FACILITY_ID |
The merchant’s facility. A merchant can have multiple client facility IDs. |
0093 |
CARRIER_FACILITY_ID |
The PB Standard facility assigned to the merchant. A merchant can be assigned multiple PB Standard facilities. |
1585 |
See Also¶
For USPS cutoff times and service suspensions, see PB Expedited Delivery FAQs.
For information on PB Delivery Guarantee see the Pitney Bowes Delivery Guarantee.
For all shipping FAQs, see FAQs for the Global Ecommerce Shipping APIs.
For all merchant FAQs, see Merchant Accounts FAQs.