Articles in this section

Available Pitney Bowes APIs

When you configure an export, import, other type of flow step using the prebuilt Pitney Bowes connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Pitney Bowes API documentation (Shipping and SendPro 360). You can also create a composite endpoint for this application in HTTP mode.

API type: Shipping

Resource

API endpoint

Export

Import

Addresses

Suggest addresses

X

Validate an address

X

Carrier license agreement

Get carrier license agreement

X

Carrier rules

Get carrier rules

X

Find carrier facilities

X

Countries list

List countries

X

Cross-border value adds

Retrieve the predicted HS code

X

Manifests

Reprint a manifest

X

Create a manifest

X

Retry a manifest

X

Merchants

Get all merchants

X

Get account balances

X

Get refill settings

X

Update auto refill settings

X

Authorize merchant

X

Register a merchant as a known shipper

X

Update a known shipper

X

Update a known shipper's partial

X

Refill postage account

X

Add a carrier account

X

Get merchant accounts

X

Pickups

Schedule a pickup

X

Cancel a pickup

X

Rates

Rate a parcel

X

Shipments

Reprint a shipment

X

Create a shipment

X

Retry a shipment

X

Void a shipment

X

Tracking

Get package status

X

Add tracking events

X

Transaction reports

List transaction reports

X

Get archived reports

X

API type: SendPro 360/Shipping 360 Platform

Resource

API endpoint

Export

Import

Address

Address validate

X

Address suggest

X

Address auto-complete

X

Batch shipment

Create bulk shipments

X

Create bulk shipments ERR

X

Bulk import shipments

X

Bulk import shipments ERR

X

Process batch

X

Void batch shipping labels

X

Get batch status

X

Get batch shipment details

X

Carrier

Retrieve carrier list

X

Add carrier

X

Delete carrier

X

Get carrier

X

Get FedEx SmartPost hub details

X

Update carrier

X

Contact

Create contact

X

Delete contact

X

Get contact by contact ID

X

Get contact list or search contact

X

Update contact details

X

Update specific fields of contact

X

Cost account management

Add cost account

X

Get cost accounts

X

Update cost account

X

Get cost account details by cost account ID

X

Delete cost account

X

Create cost account import job

X

Process import cost account job

X

Get import cost account job status

X

Custom fields

Get custom fields

X

Get custom field by ID

X

Decode

Decode tracking number

X

Defaults

Create defaults

X

Get all defaults

X

Update defaults

X

Get defaults by ID

X

Delete defaults by ID

X

Electronic trade document

Upload electronic trade document

X

HS classification

Get HS Code for Single Country

X

Get HS Codes Across Countries

X

Get Shipping Restrictions for Single Country

X

Get Shipping Restrictions Across Countries

X

Calculate Duties and Taxes for Single Country

X

Calculate Duties and Taxes for Single Item Across Countries

X

Inbound sites

Add inbound site

X

Get inbound site

X

Update inbound site

X

Delete inbound site

X

Get inbound sites by location

X

Known shipper

Register known shipper

X

Update known shipper

X

Get known shipper

X

Update known shipper state

X

Delete known shipper

X

Location management

Get divisions details

X

Get locations details

X

Manifest

Create manifest document

X

Get manifest document

X

Create Manifest

X

Reprint manifest

X

Merchant account

Create merchant onboarding invitation

X

Multipiece shipment

Multipiece rates

X

Reprint multipiece shipment

X

Cancel multipiece shipment

X

Create multipiece shipment

X

Packages

Generate tracking number

X

Create image

X

Search package

X

Add package

X

Get package

X

Update package

X

Archive package

X

Get package by tracking

X

Payment

Get payment methods

X

Get payment account balance

X

Set rank of payment method

X

Set payment method status

X

Refill amount to the wallet

X

Pickups

Schedule pickup

X

Get pickups

X

Cancel pickups

X

Get pickup document

X

Cancelled pickup document

X

Print

Print document

X

Printer mapping

X

Get printer mapping

X

Delete printer mapping

X

Job status

X

Shipment

Get carriers

X

Get countries

X

Get services

X

Get parcel types

X

Get special services

X

Get carrier accounts

X

Rate shop and get single rate

X

Create shipment

X

Create shipment v2

X

Get all shipments

X

Create ERR single coversheet

X

Get shipment by ID

X

Reprint shipment

X

Cancel shipment

X

Signature image ERR

X

Cancel stamps ERR

X

Download BPOD files

X

Shipment by rate shop

Rate shipment

X

Reprint shipment

X

Cancel shipment

X

Tracking

Get shipment tracking details

X

Subscribe tracking details

X

Webhook

Get applicable event list for webhook configuration

X

Create webhook configuration

X

Get all webhooks

X

Update webhook

X

Get webhook details by ID

X

Delete webhook

X