Pitney Bowes Shipping APIs Documentation

Welcome

Welcome to the Documentation for the PB Shipping APIs!

API Overview How to set up accounts and access the APIs. Merchant Accounts How to enroll merchants to ship via the APIs. FAQs Our knowledge base of frequently asked questions. Release Notes Get the latest release information.

Getting Started Try out the APIs in the sandbox environment. Carriers How to ship with each carrier. Error Codes View all error codes and available solutions. Contact Us Contact our sales, technical, and account teams.

Copyright © 2020 Pitney Bowes Inc. All rights reserved.

Getting Started

• API Overview
• Getting Started in Sandbox
• Merchant Accounts
• Carriers
  • USPS
  • PB Standard
    • APAC Services
    • APAC Services (Chinese)
  • PB Presort
  • CBDS
    • Invoices
    • Compliance
      • Canada
    • Hubs
      • California
      • Chicago
      • Kentucky
      • New Jersey
    • SFTP
  • FedEx
  • UPS
• Value-Added Services

Authentication API

• OAuth Token

Core APIs

• Carrier Information
  • Get Carrier Rules
  • Get Carrier Countries
  • Find Carrier Facilities
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Parcels
• Shipments
  • Create Shipment
    • USPS
    • PMOD
    • PB Standard
    • PB Presort
    • CBDS
    • FedEx
    • UPS
    • PB Expedited Return
    • PB Standard Return
    • Scan-Based Return
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Manifests
  • Create Manifest
    • USPS SCAN Form
    • PB Standard
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Tracking
  • Track Package
  • Add Tracking Events
    • Tracking Events
  • Tracking Webhook
• Transaction Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Parcel Protection
  • Request Quote
  • Request Coverage
  • Void Coverage
  • Reports
• Additional Services
  • Shopping Cart Quotes

Accounts APIs

• Merchant Signup
  • Merchant Signup Tutorial
  • Retrieve Payment Iframe
  • Sign Up a Merchant
• Merchant Authorization
• Merchant Registration
• View Merchant Accounts
• Postage Management
  • Get Account Balances
  • Refill Postage Account
  • Get Refill Settings
  • Edit Refill Settings
• Carrier Account Registration
  • Get Carrier License
  • Register Existing Carrier Account
    • Input Parameters

Reference

• FAQs
  • Developers
  • International Shipping
  • Labels
  • Manifests
  • Merchants
  • Parcels
  • Payments
  • PB Standard
  • Rates and Prices
  • Refunds
  • Transaction Reports
  • UPS
  • USPS
    • Expedited Returns
    • Scan-Based Returns
    • APV
    • Price Changes
  • Value-Added Services
    • Address Validation
    • Delivery Guarantee
• Error Codes
  • Error Object
  • HTTP Status Codes
• Resource Objects
• Shipment Options
• API Resource List
• Services, Parcels, Labels

Support

• Release Notes
• Best Practices
• Troubleshooting
• Contact Us

• Glossary

 
 
 
 

• next

© Copyright 2020, PB.