Pitney Bowes Global Ecommerce APIs Documentation

Welcome

Welcome to the Documentation for the Pitney Bowes Global Ecommerce APIs!

API Overview How to set up accounts and access the APIs. Carriers How to ship with PB Expedited & Standard, PB Presort, PB Cross-Border, and other carriers. Fulfillment Manage inventory, orders, kits, and returns. Release Notes The latest release information. Contact Us Contact technical, accounts, and sales teams.

Getting Started Try out the APIs in the Sandbox environment. Merchant Accounts How to enroll merchants to ship via the APIs. FAQs A knowledge base of frequently asked questions. Error Codes View all error codes and available solutions. Glossary Common terms and links to related pages.

Copyright © 2023 Pitney Bowes Inc. All rights reserved.

Getting Started

• API Overview
• Getting Started

Authentication API

• OAuth Token

Shipping APIs

• Carriers Overview
  • Pitney Bowes
    • Shipping Workflow
    • APAC Services
  • PB Presort
  • Cross-Border (CBDS)
    • Delivery Solutions
    • Compliance
      • CA Rules
    • Invoices
    • Hubs
      • CA Zones
    • Shipping Lanes
      • Postal Codes
  • FedEx
  • UPS
• Carrier Rules
  • Get Rules
  • Get Countries
  • Find Facilities
• Address Validation
  • Validate Address
  • Suggest Addresses
• Rate Parcels
• Shipments
  • Create Shipment
    • PB Exp Delivery
    • PB Std Delivery
    • PB Exp Returns
    • PB Std Returns
    • PB Presort
    • CBDS Outbound
    • CBDS Inbound
    • CBDS Domestic
    • CBDS Returns
    • PMOD
    • FedEx
    • UPS
  • Reprint Shipment
  • Retry Shipment
  • Void Shipment
  • Electronic Delivery
• Manifests
  • Create Manifest
    • PB Expedited
    • PB Standard
    • PMOD
  • Reprint Manifest
  • Retry Manifest
• Containers
  • Print Label
  • Print Batch Labels
  • Reprint Batch Labels
• Tracking
  • Track a Parcel
  • Add Tracking Events
  • Webhook Service
    • Legacy Webhook
  • Online Tracking
  • Event Codes
  • Standalone Track API
• Transaction Reports
  • Get Transaction Reports
  • Get Archived Reports
• Pickups
  • Schedule Pickup
  • Cancel Pickup
• Cross-Border Value-Adds
  • Retrieve HS Code
  • Shopping Cart Quotes

Shipping APIs Reference

• API Resources
• API Resource Objects
• Shipment Options
  • Example Output for Print Custom Message
• FAQs
  • Parcels
  • Labels
  • References
  • Customs
  • Manifests
  • Reports
  • Expedited Delivery
  • Expedited Returns
  • Standard Delivery
  • Standard Returns
  • Single PB Delivery Request
  • FedEx
  • UPS
  • APV
  • Address Validation
  • Delivery Guarantee

Merchant Accounts APIs

• Merchant Accounts
  • Authorize Merchants
    • Provide Signup URL
  • Register Merchants
  • Get Merchants
• 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
• FAQs (Merchants)
  • Developers
  • Merchants
  • Payments
  • Refunds
  • Rates & Pricing

Fulfillment APIs

• Fulfillment Overview
  • Object Reference
  • Legacy API Map
• 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 & Shipments
  • Create Order
  • Update Order
  • Create & Update Bulk Orders
  • Change Order Item
  • View Order
  • Get Order Status
  • Find Orders
  • Cancel an Order
  • Bulk Cancel
  • Find Shipment Details
• 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

Support

• Release Notes
• Error Codes
  • Error Object
  • HTTP Status Codes
• Best Practices
• Traffic Shaping
• Troubleshooting
• Contact Us

• Glossary

 
 
 
 

• next

© Copyright 2023, PB.