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 © 2019 Pitney Bowes Inc. All rights reserved.

Setup

• API Overview
• Getting Started in Sandbox
• Merchant Accounts
• Carriers
  • USPS
  • UPS
  • Newgistics
  • PB Presort
  • PB Cross-Border
    • PB Cross-Border Consolidation Centers
• Value-Added Services

Authentication API

• OAuth Token

Carrier Services APIs

• Carrier Info
  • Get Carrier Rules
  • Get Carrier License
  • Get Carrier Countries
• Rate Parcels
• Shipments
  • Create Shipment
    • USPS
    • Scan-Based Return
    • Newgistics
    • PB Presort
    • PB Cross-Border
    • UPS
    • PMOD
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Manifests
  • Create Manifest
    • USPS SCAN Form
    • Newgistics
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Transaction Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup

Value-Added Services APIs

• Address Validation
  • Validate Address
  • Suggest Addresses
• Parcel Protection
  • Request Quote
  • Request Coverage
• Tracking

Account Management APIs

• Merchant Signup API
  • Merchant Signup Tutorial
  • Retrieve Payment Iframe
  • Sign Up a Merchant
• Authorize Merchant
• Register Merchant
• Register Carrier Accounts
  • Register an Existing Carrier Account
• Postage Management
  • Get Account Balances
  • Refill Postage Account
  • Get Refill Settings
  • Edit Refill Settings
• Get All Merchants
• Deactivate Merchant

Reference

• Resource Objects
• Services, Parcels, & Labels
  • USPS
  • Newgistics
  • PB Presort
  • PB Cross-Border
  • UPS
• Shipment Options
• Error Codes
  • Error Object
  • HTTP Status Codes
• API Resource List

FAQs and Support

• FAQs
  • Environments and Authentication
  • Merchants
  • Rates & Payments
    • Rates
    • Parcel Protection
    • Payments
    • Refunds
  • Parcels & Dimensions
  • Labels
  • Manifests
  • Transaction Reports
  • USPS
    • Scan-Based Returns
    • Customs
    • Delivery Guarantee
    • APV
    • Price Changes
  • Newgistics
  • Cross-Border
    • Access via SFTP
  • UPS
• Release Notes
• Best Practices
• Troubleshooting
• Contact Us
• Glossary

 
 
 
 

• next

© Copyright 2019, PB.