Pitney Bowes Shipping API

Pitney Bowes Shipping API, developers can integrate features such as comparing shipping rates from multiple carriers, creating and purchasing shipping labels, tracking packages, scheduling pickups, managing returns, and accessing other shipping features. These APIs also offers a variety of shipping services, including international shipping and multi-carrier rate shopping, which allows developers to choose the best carrier and rate for each shipment.

Developers can also benefit from discounted shipping rates offered, as well as access to features such as address validation and customs documentation.

PREREQUISITE

In order to use the Pitney Bowes Shipping APIs, you need a Developer Account with the Pitney Bowes Shipping API platform. You can generate API keys through this Developer Account. Once you have the API key, you can use it to authenticate your requests and access the full range of shipping functionality offered.

Getting Started

Follow this tutorial for Authentication and to make your first API call. In this guide, you will learn how to verify an address using the API.

1. Sign up or Log In

Sign Up for a Developer Account:

1Register for a free Pitney Bowes developer account at the Developer Portal Signup Page.
2Use a regularly monitored email for signup. The email address you use cannot be changed later.
3Fill out all the required details on the Registration form, including your Email Address, First Name, Last Name, Company Name, Phone Number, and other mandatory details.
4After successful registration, you will receive a verification email at the registred email address.
5Verify your email address, setup a new password, and sign in with your credentials.

Already Have an Account?

1If you already have an account, log in at the Developer Portal.

2. Generate your secure token

While logged into the application, click on the API tab in the top navigation.

Generate API Keys Under API Keys, there are two options: Sandbox Key and Production Key.
  1. Use Production Key for production ready use of the API.
  2. Use Sandbox Key for testing and development.
Click Generate Key and Secret to generate Client ID and Secret. Use these credentials to generate the Bearer Token.
ParameterDescription
Client IDThe unique identifier assigned to the client application
SecretA confidential string used to authenticate the client
Developer Partner IDA unique identifier for associated developer partner.

Please note the Developer Partner ID parameter is not required for token generation. In cases where the developer is the only partner, it becomes optional and can be used at the developer's discretion. This is mandatory when the developer has multiple partners. This is being used in `X-PB-Developer-Partner-ID` header in some of APIs. Please refer to detailed documentation for more information.

3. Generate your API Token

Try out the Authentication API to generate your API Token.

4. Make your first API call

To make sure everything is working, make a simple call to verify an address in your account using the Bearer Token generated in the above step.
Sample Request
Copy
Copied
curl --location 'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/address/verify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearerToken}}' \
--data '{
    "addressLine1": "1001 Bridgeport AA ",
    "cityTown": "Shelton",
    "countryCode": "US",
    "name": "John Smith",
    "postalCode": "06484"
}'

If your request to verify an address was a success, the response should look like the following.

Sample Response
Copy
Copied
{
    "addressLine1": "1001 Bridgeport Ave",
    "cityTown": "Shelton",
    "countryCode": "US",
    "name": "John Smith",
    "postalCode": "06484-4675",
    "residential": false,
    "stateProvince": "CT",
    "status": "VALIDATED_CHANGED"
}

NOTE

Clients are advised to avoid strict validation on the response body to ensure that any new fields or objects added in the future do not cause issues or break existing integrations.

5. Next steps

You now know how to use the API. Navigate to the catalog and try out the APIs. Refer to our API Catalog.