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. Contact Us Contact our sales, technical, and account teams.

Getting Started Try out the APIs in the sandbox environment. Carriers How to ship with each carrier. Release Notes Get the latest release information.

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
    • Supported Countries and Consolidation Centers
• Value-Added Services

APIs

• OAuth Token
• Merchants
  • Merchant Signup API
    • Merchant Signup Tutorial
    • Retrieve Payment Iframe
    • Sign Up a Merchant
  • Authorize Merchant
  • Register Merchant
  • Register Existing Carrier Accounts
    • Register an Existing Carrier Account
  • Get All Merchants
  • Get Account Balances
  • Refill Postage Account
  • Auto Refill
    • Get Settings
    • Edit Settings
  • Deactivate Merchant
• Carrier Info
  • Get Carrier Rules
  • Get Carrier License
  • Get Carrier Countries
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Packages
• Shipments
  • Create Shipment
    • USPS
    • USPS Return Label
    • Newgistics
    • PB Presort
    • UPS
    • PMOD
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Manifests
  • Create Manifest
    • USPS SCAN Form
    • Newgistics
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Tracking
• Transaction Reports

Reference

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

Support

• FAQs
  • Environments
  • Authentication
  • Merchants
  • Carriers
  • Rates
  • Parcels
  • Labels
  • USPS
    • Return Labels
    • Customs
    • Parcel Protection
    • Delivery Guarantee
    • APV
  • Newgistics
  • United Parcel Service
  • Manifests
  • Transaction Reports
  • Payments
  • Refunds
  • Cross-Border Delivery Service
    • Access via SFTP
• Release Notes
• Best Practices
• Troubleshooting
• Contact Us
• Glossary

 
 
 
 

• next

© Copyright 2019, PB.