Pitney Bowes Global Ecommerce APIs Documentation

Welcome

Welcome to the Documentation for the PB Ecommerce APIs!

API Overview How to set up accounts and access the APIs. Merchants How to enroll merchants to ship via the APIs. FAQs Our knowledge base of frequently asked questions. Release Notes Get the latest release information. Glossary Common terms and links to related pages.

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

Getting Started

• API Overview
• Getting Started
• Merchants
• Carriers
  • Pitney Bowes
    • APAC Services
  • PB Presort
  • Cross-Border (CBDS)
    • Delivery
    • Compliance
      • Canada
    • Invoices
    • Consolidation Centers
      • Canada Zones
    • Supported Countries
    • Postal Codes
    • SFTP
  • FedEx
  • UPS

Authentication API

• OAuth Token

Shipping APIs

• Carrier Information
  • Get Carrier Rules
  • Get Carrier Countries
  • Find Carrier Facilities
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Parcels
• Shipments
  • Create Shipment
    • PB Delivery
    • PB Expedited Returns
    • PB Standard Returns
    • PB Presort
    • PB Cross-Border
    • PMOD
    • FedEx
    • UPS
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
• Manifests
  • Create Manifest
    • Pitney Bowes
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Containers
• Tracking
  • Track Package
  • Add Tracking Events
  • Tracking Webhook
  • Tracking Codes
• Transaction Reports
  • Get Transaction Reports
  • Get Archived Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Cross-Border Value-Added Services
  • Retrieve HS Code
  • Shopping Cart Quotes

Account APIs

• Merchant Authorization
  • Provide a Signup URL
• Merchant Registration
• Get Merchant Accounts
• 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

Reference

• FAQs
  • Developer Accounts
  • Merchant Accounts
  • Payments & Balances
  • Refunds
  • Rates & Pricing
  • Parcel Size
  • Labels
  • Reference Fields
  • Customs
  • Manifests
  • Transaction Reports
  • PB Expedited
    • APV
    • Price Changes
  • PB Expedited Returns
  • PB Standard
  • PB Standard Returns
  • Switch Between PB Services
  • FedEx
  • UPS
  • Address Validation
  • Delivery Guarantee
• API Resources
• Resource Objects
• Shipment Options
  • Example Output for Print Custom Message
• Client SDKs
• Error Codes
  • Error Object
  • HTTP Status Codes

Support

• Release Notes
• Best Practices
• Traffic Shaping
• Troubleshooting
• Contact Us

• Glossary

 
 
 
 

• next

© Copyright 2021, PB.