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. API Resources Resources for the Shipping and Accounts APIs. Release Notes Get the latest release information. 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. Fulfillment Manage inventory, orders, kits, and returns. Resource Objects Common objects used in the APIs. Error Codes View all error codes and available solutions. Glossary Common terms and links to related pages.

Copyright © 2022 Pitney Bowes Inc. All rights reserved.

Getting Started

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

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
  • Electronic Delivery
• Manifests
  • Create Manifest
    • Pitney Bowes
    • PB Presort
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Containers
• Tracking
  • Track Package
  • Add Tracking Events
  • Tracking Webhook
  • Online Tracking Page
  • Tracking Event Codes
• Transaction Reports
  • Get Transaction Reports
  • Get Archived Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Cross-Border Value-Adds
  • Retrieve HS Code
  • Shopping Cart Quotes

Accounts APIs

• Merchant Accounts
  • Merchant Authorization
    • Provide 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

Fulfillment APIs

• Product, ASN, Inventory
  • Create a Product
  • Update a Product
  • Create or Update Bulk Products
  • View a Product
  • Find Products
  • Create ASN
  • Update ASN
  • View ASN
  • Find ASN
  • Cancel ASN
  • View Inventory
• Orders
  • Create Order
  • Update Order
  • Create & Update Bulk Orders
  • Change Order Item
  • View Order
  • Get Order Status
  • Find Orders
  • Cancel an Order
  • Bulk Cancel
  • Find Fulfilled Orders
• BOM, Work Orders
  • Create BOM
  • Update BOM
  • View BOM
  • Create Work Orders
  • Update Work Orders
  • View Work Orders
  • Find Work Orders
  • Cancel Work Orders
• Returns
  • Create Return Order
  • Update Return Order
  • Bulk Return Orders
  • View Return Order
  • Find Return Order

Reference

• FAQs
  • Accounts
    • Developers
    • Merchants
    • Payments
    • Refunds
    • Rates & Pricing
  • Shipping
    • Parcels
    • Labels
    • References
    • Customs
    • Manifests
    • Reports
  • Carriers
    • PB Expedited
    • PB Expedited Returns
    • APV
    • PB Standard
    • PB Standard Returns
    • Switch between Expedited & Standard
    • FedEx
    • UPS
  • Value-Added Services
    • Address Validation
    • Delivery Guarantee
• API Resources
  • Fulfillment Resources
• Resource Objects
  • Fulfillment Objects
• Shipment Options
  • Example Output for Print Custom Message
• Error Codes
  • Error Object
  • HTTP Status Codes

Support

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

• Glossary

 
 
 
 

• next

© Copyright 2022, PB.