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. Error Codes View all error codes and available solutions.

Getting Started Try out the APIs in the sandbox environment. Carriers How to ship with each carrier. Release Notes Get the latest release information. 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
  • Newgistics
    • APAC Services
    • APAC Services (Chinese)
  • Presort
  • Cross-Border
    • California center
    • Chicago center
    • Kentucky center
    • New Jersey center
  • FedEx
  • UPS
• Value-Added Services

Authentication API

• OAuth Token

Core APIs

• Carrier Rules
  • Get Carrier Rules
  • Get Carrier Countries
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Parcels
• Shipments
  • Create Shipment
    • USPS
    • Newgistics
    • Presort
    • PMOD
    • Scan-Based Return
    • Pure Post Return
    • Cross-Border
    • FedEx
    • UPS
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Manifests
  • Create Manifest
    • USPS SCAN Form
    • Newgistics
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Tracking
  • Track Package
  • Tracking Webhook
• Transaction Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Parcel Protection
  • Request Quote
  • Request Coverage
  • Void Coverage
  • Reports
• Cross-Border 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
  • Carrier Account Input Parameters

Reference

• Resource Objects
• Shipment Options
• Error Codes
  • Error Object
  • HTTP Status Codes
• API Resource List

FAQs and Support

• FAQs
  • Developers
  • Merchants
  • Payments
  • Refunds
  • Rates
  • Parcels
  • Labels
  • International
  • Manifests
  • Transaction Reports
  • USPS
    • Pure Post Returns
    • Scan-Based Returns
    • APV
    • Price Changes
  • Newgistics
  • Cross-Border
    • Canada Restrictions
  • UPS
  • Value-Added Services
    • Address Validation
    • Delivery Guarantee
• Release Notes
• Best Practices
• Troubleshooting
• Contact Us
• Glossary

 
 
 
 

• next

© Copyright 2020, PB.