Carrier Account Registration

Overview

Pitney Bowes provides the following APIs to register a merchant’s outside carrier account for use with the PB Shipping APIs. Currently, the Shipping APIs support registration of UPS® carrier accounts. To implement the APIs, see How to Register a Merchant’s Existing Carrier Account below.

API Operations

API
Method Endpoint

Carrier License Agreement

GET

/v1/carrier/license-agreements?carrier={carrier}&originCountryCode={two-character-ISO-code}
 

Register an Existing Carrier Account

POST

/v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier}
 

How to Register a Merchant’s Existing Carrier Account

1. Obtain the account information

Obtain the information about the merchant’s carrier account that will be required by the Register an Existing Carrier Account API. Save this information for use in step 4. Obtain the following:

Required Information Description
Account number The merchant’s account number with the carrier.
Account address The Ship From address as it appears on the merchant’s account with the carrier.
Contact title and address The title and address of the primary contact that the merchant provided to the carrier.
Identity and IP address of the merchant’s machine

You need the black-box identity and IP address of the merchant’s machine.

For help in retrieving the black-box identity, consult your Pitney Bowes implementation engineer.

Invoice information

UPS Only: If the merchant has shipped in the last 90 days, you must have information from the most recent invoice. If the merchant has not shipped in the last 90 days, no invoice information is required.

Merchants can retrieve invoices by logging into their accounts at https://www.ups.com.

2. Retrieve the license agreement

Issue the Carrier License Agreement API to retrieve the text of the merchant’s license agreement. Save this information for use in steps 3 and 4.

3. Present the license agreement

Present the text of the license agreement to the merchant and obtain the merchant’s approval for the agreement.

4. Register the account

Issue the the Register an Existing Carrier Account API to register the merchant’s carrier account with Pitney Bowes.

5. Store the generated ID

The Register an Existing Carrier Account API returns the shipperCarrierAccountId. Store this ID. You will pass this ID in the X-PB-Shipper-Carrier-AccountId request header whenever the merchant performs an operation that uses this carrier.