Pitney Bowes Shipping APIs Documentation

Welcome

Welcome to the Documentation for the Pitney Bowes Shipping APIs!

API Overview How to set up accounts and access the APIs. Carriers How to ship with PB Expedited & Standard, PB Presort, PB Cross-Border, and other carriers. Release Notes The latest release information. Contact Us Contact technical, accounts, and sales teams.

Getting Started Try out the APIs in the Sandbox environment. Merchant Accounts How to enroll merchants to ship via the APIs. FAQs A knowledge base of frequently asked questions. Error Codes View all error codes and available solutions. Glossary Common terms and links to related pages.

Copyright © 2023 Pitney Bowes Inc. All rights reserved.

Getting Started

• API Overview
• Getting Started

Authentication API

• OAuth Token

Shipping APIs

• Carriers
  • PB Expedited
    • Workflow
  • PB Presort
  • FedEx
  • UPS
• Carrier Rules
  • Carrier Rules
  • Carrier Countries
  • Carrier Facilities
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Parcels
• Shipments
  • Create Shipment
    • PB Exp Delivery
    • PB Exp Returns
    • PB Presort
    • PMOD
    • FedEx
    • UPS
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Manifests
  • Create Manifest
    • PB Expedited
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Tracking
  • Track a Parcel
  • Add Tracking Events
  • Webhook Service
    • Legacy Webhook
  • Online Tracking
  • Event Codes
• Transaction Reports
  • Get Transaction Reports
  • Get Archived Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup

Shipping APIs Reference

• API Resources
• API Resource Objects
• Shipment Options
  • Example Output for Print Custom Message
• Shipping FAQs
  • Rates
  • Parcels
  • Labels
  • References
  • Customs
  • Manifests
  • Reports
  • PB Expedited
    • Delivery
    • Returns
    • Billing Extract File
    • Single Request
    • Hazmat
  • UPS
  • Additional Services
    • APV
    • Address Validation
    • Delivery Guarantee

Accounts APIs

• Merchant Accounts
  • Authorize Merchants
    • Provide Signup URL
  • Register Known Shipper
  • Update Known Shipper
  • Update a Known Shipper - Partial
  • Get Merchants
• Postage Management
  • Get Account Balances
  • Refill Postage Account
  • Get Refill Settings
  • Edit Refill Settings
• Add Carrier Accounts
  • Get Carrier License
  • Add Carrier Account
    • Input Parameters
• Accounts FAQs
  • Developers
  • Merchants
  • Payments
  • Refunds

Support

• Release Notes
• Error Codes
  • Error Object
  • HTTP Status Codes
• Best Practices
• Traffic Shaping
• Troubleshooting
• Contact Us

• Glossary

 
 
 
 

• next

© Copyright 2024 Pitney Bowes Inc. All rights reserved.