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

Function ID
Rate 1
Ship 2
Track 3
Void 4
End of Day List 15
End of Day Action 16
Address Validation 30
End of Day 124

Top

Carrier Services

Carrier Service ID
Express Mail International 989
First Class Mail 980
First Class Mail International 987
First Class Package International 988
Ground Advantage 948
Ground Advantage Returns 949
Library Mail 986
Media Mail 985
Priority Mail 981
Priority Mail Express 982
Priority Mail International 990
Priority Mail Return Service 914

Top

Special Services

Special Service ID
Special Handling 36
Certified 37
Delivery Confirmation - No Signature 38
Delivery Confirmation - Signature Required 39
Delivery Confirmation - Adult Signature Required 40
Delivery Confirmation - Signature Waiver 42
Registered 54
COD - Any 55
Insurance 61
Restricted Delivery 66
Return Receipt 76
Disposition Method - Return 116
Disposition Method - Abandon 117
Disposition Method - Redirect 118

Top

Package Types

Package Type ID
Flat Rate Box 648
Flat Rate Envelope 649
Large Envelope/ Flat 650
Large Flat Rate Box 651
First Class Large Envelope/Flat 652
Legal Flat Rate Envelope 653
Letter 654
Military Large Flat Rate Box 655
Package 656
Padded Flat Rate Envelope 657
Regional Box A 658
Regional Box B 659
Small Flat Rate Box 661
International Letter 985
Nonmachineable Letter 10083
International Nonmachineable Letter 10084
Soft Pack Envelope 10085
DVD Flat Rate Box 10086
Irregular Package 10087
Large Video Flat Rate Box 10088
Postcard 10165

Top

Label Configuration

Output Type ID Format Generate From Printer Orientation and Scale
Label 1 PDF
ZPL
Carrier Client/Windows/Response
Windows/Response
-
Thermal 4x6

Top

Document Configuration

Output Type ID Format Generate From Printer Orientation and Scale Margin
Manifest 10 PDF, PDF Raw Carrier Windows/Client/Response - -
PB Shipping API Customs Form 2976 236 PDF, PDF Raw Carrier Windows/Client/Response Letter (8.5 x 11) -

Top

Article last edited 26 January 2023