Register Existing Carrier Accounts


Use these steps to register a merchant’s existing carrier account for use with the PB Shipping APIs. The steps use two API operations: Get Carrier License Agreement and Register an Existing Carrier Account. Currently, the APIs support integration with UPS® (United Parcel Service).

1. Obtain the merchant’s carrier account information.

Your application must retrieve the information about the merchant’s existing carrier account that is required by the Register an Existing Carrier Account API.

2. Obtain the merchant’s approval for the carrier’s license agreement.

Your application must present the merchant with the text of the carrier’s license agreement, as retrieved by the Carrier License Agreement API, and must obtain the merchant’s approval for the agreement.

Keep the text of the carrier’s license agreement for use in the Register an Existing Carrier Account API.

3. Register the merchant’s carrier account with Pitney Bowes.

Using the information retrieved in Step 1, register the carrier account using the Register an Existing Carrier Account API.

4. Store the shipper-carrier account ID for use in future API calls.

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


API Operations Used in These Steps

API
Method Endpoint

Register an Existing Carrier Account

POST

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

Carrier License Agreement
(This operation is part of the Carrier Info APIs.)
 

GET

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