PB Shipping API Reference

CarrierID=106

Move to: Functions, Carrier Services, Special Services, Package Types, Label Configuration, Document Configuration

Go to: Carrier Components List

About

PB Shipping API - USPS is a browser-based postal solution provided by Pitney Bowes. For more information, visit the PB Shipping API website.

Setup

Setup My System (onboarding wizard) is supported for this carrier. If onboarding manually, alongside the guidance given in Setup PB Shipping API and Set up a carrier, the key detail for this carrier is:

  • Requirements:
    • Account Number (Developer ID)
    • Shipping Key (Merchant ID)
    • Payment Account
    • Security Credentials Username (Key) and Password (Secret)
  • Setup stages (Administration App):
    • Enable PB Shipping API (Carriers page), and add Security Credentials (the Identifier field is your Security Credentials Username).
    • Add the Account and Carrier Permissions:
    • HAVE SHIPPING KEY DON'T HAVE SHIPPING KEY
      • Add the Account.
      • Click the ADD SHIPPING KEY button, and manually add the Shipping Key detail.
      • Add the Account, excluding the Shipping Key for the time being.
      • Add Carrier Permissions.
      • Go back to the Account and click the REQUEST SHIPPING KEY button. Once you fill in the form, your Shipping Key details will be added to the account.
      • Go back to Carrier Permissions, and add in the Shipping Key detail.
    • Configure address validation settings. See Setup PB Shipping API.
    • Set up Outputs. Optionally, set up Expedited Returns Labels. See Setup PB Shipping API.
    • Optionally, generate PB Shipping API-specific reports. See Setup PB Shipping API.

Top

Functions

(missing or bad snippet)

Top

Carrier Services

Carrier ServiceID
Express Mail International989
First Class Mail980
First Class Mail International987
First Class Package International988
Ground Advantage948
Ground Advantage Returns949
Library Mail986
Media Mail985
Priority Mail981
Priority Mail Express982
Priority Mail International990
Priority Mail Return Service914

Top

Special Services

Special ServiceID
Special Handling36
Certified37
Delivery Confirmation - No Signature38
Delivery Confirmation - Signature Required39
Delivery Confirmation - Adult Signature Required40
Delivery Confirmation - Signature Waiver42
Registered54
COD - Any55
Insurance61
Restricted Delivery66
Return Receipt76
Disposition Method - Return116
Disposition Method - Abandon117
Disposition Method - Redirect118

Top

Package Types

Package TypeID
Flat Rate Box648
Flat Rate Envelope649
Large Envelope/ Flat650
Large Flat Rate Box651
First Class Large Envelope/Flat652
Legal Flat Rate Envelope653
Letter654
Military Large Flat Rate Box655
Package656
Padded Flat Rate Envelope657
Regional Box A658
Regional Box B659
Small Flat Rate Box661
International Letter985
Nonmachineable Letter10083
International Nonmachineable Letter10084
Soft Pack Envelope10085
DVD Flat Rate Box10086
Irregular Package10087
Large Video Flat Rate Box10088
Postcard10165

Top

Label Configuration

Output TypeIDFormatGenerate FromPrinterOrientation and Scale
Label1PDF
ZPL
CarrierClient/Windows/Response
Windows/Response
-
Thermal 4x6

Top

Document Configuration

Output TypeIDFormatGenerate FromPrinterOrientation and ScaleMargin
Manifest10PDF, PDF Raw Carrier Windows/Client/Response--
PB Shipping API Customs Form 2976236PDF, PDF RawCarrierWindows/Client/ResponseLetter (8.5 x 11)-

Top

Article last edited 26 January 2023