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
  • PB Expedited and Standard
    • Workflow
    • APAC Services
  • PB Presort
  • Cross-Border (CBDS)
    • Delivery Solutions
    • Compliance
      • CA Rules
    • Invoices
    • Hubs
    • Shipping Lanes
      • Postal Codes
  • FedEx
  • UPS
• Carrier Rules
  • Carrier Rules
  • Carrier Countries
  • Carrier 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
  • PB Standard Container
  • Master Carton
  • Retry Master Carton
  • Reprint Master Carton
  • Delete Master Carton
  • Batch Labels
  • Reprint Batch Labels
• Tracking
  • Track a Parcel
  • Add Tracking Events
  • Webhook Service
    • Legacy Webhook
  • Online 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

Shipping APIs Reference

• API Resources
• API Resource Objects
• Shipment Options
  • Example Output for Print Custom Message
• Shipping FAQs
  • Rates
  • Parcels
  • Labels
  • References
  • Customs
  • Manifests
  • Reports
  • PB Expedited
    • Delivery
    • Returns
    • Billing Extract File
    • Single Request
    • Hazmat
  • PB Standard
    • Delivery
    • Returns
    • Hazmat
  • UPS
  • Additional Services
    • APV
    • Address Validation
    • Delivery Guarantee

Accounts APIs

• Merchant Accounts
  • Authorize Merchants
    • Provide Signup URL
  • Register Known Shipper
  • Update Known Shipper
  • Update a Known Shipper - Partial
  • 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
• Accounts FAQs
  • Developers
  • Merchants
  • Payments
  • Refunds

Fulfillment APIs

• Fulfillment Overview
  • Legacy API Map
• Products
  • Create Product
  • Update Product
  • Bulk Products
  • View Product
  • Find Products
  • Shared Products Objects
    • Product Details
    • Image
    • Dimensions
    • Inventory Parameters
• ASN
  • Create ASN
  • Update ASN
  • View ASN
  • Find ASN
  • Cancel ASN
  • Shared ASN Objects
    • ASN Lines
    • Address
• Inventory
• Orders
  • Create Order
  • Update Order
  • Bulk Orders
  • Change Item
  • View Order
  • Order Status
  • Find Orders
  • Cancel Order
  • Bulk Cancel
  • Shared Orders Objects
    • Shipping Details
    • Order Lines
    • Order Charges
    • Price
    • Additional Details
    • Address
• Shipments
• BOM
  • Create BOM
  • Update BOM
  • View BOM
  • Find a BOM
• Work Orders
  • Create Work Orders
  • Update Work Orders
  • View Work Orders
  • Find Work Orders
  • Cancel Work Orders
• Return Orders
  • Create Return Order
  • Update Return Order
  • Bulk Return Orders
  • View Return Order
  • Find Return Order
  • Shared Returns Objects
    • Address
    • Shipping Details
    • Return Order Lines

Support

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

• Glossary

 
 
 
 

• next

© Copyright 2023 Pitney Bowes Inc. All rights reserved.