Overview
This guide describes how to configure a USPS Ship carrier account for a Connect eCommerce (CeC) platform using an EasyPost Wallet, as well as how to onboard Child or UTM users to access platform rates.
Platform Account Requirements (CeC)
When a platform or marketplace joins the USPS Connect eCommerce (CeC) program, a direct relationship is established with USPS. The following setup steps must be completed before labels can be generated:
- USPS must configure the platform’s negotiated rates within an Enterprise Payment Account. This will be referred to as the Platform EPA.
- USPS must configure the platform’s merchant rates within an Enterprise Payment Account. This will be referred to as the Merchant EPA.
- The platform signs an EFT enrollment with USPS to designate a bank account for commission payouts. The delta between the Platform EPA and Merchant EPA is referred to as the Platform Commission.
Platforms are required to both purchase postage from USPS at the Merchant Rate Card (MRC) and resell that postage to their customers at MRC. USPS then calculates the platform’s commission and returns it via electronic funds transfer (EFT) the following day after the postage transaction.
To track commission payments per tracking code, platforms should enable the Platform Commission Report as part of their data feeds. For more details, see the USPS Ship Package Data Feeds Documentation on PostalPro.
Prerequisites
- USPS Business Customer Gateway (BCG) or Customer Onboarding Portal (COP) login
- Platform Enterprise Payment Account (EPA)
- Merchant Rate Card (MRC) Account (EPA)
- Customer Registration ID (CRID)
- Mailer ID (MID)
- Manifest MID
- Returns MID
- CeC NSA Contract Number
Create a Platform Account via OAuth
USPS Ship platform accounts must be created using the OAuth registration endpoint.
curl -X POST https://api.easypost.com/v2/carrier_accounts/register_oauth \
-u <api-key>: \
-H 'Content-Type: application/json' \
-d '{
"carrier_account_oauth_registrations": {
"type": "UspsShipAccount",
"description": "",
"reference": "",
"payment_mode": "aggregation"
}
}'
The response includes a partner_oauth_url, which directs to the EasyPost Partner OAuth Portal to complete account authorization.
The flow redirects to the USPS Sign-In Page to authenticate or create a USPS account.
Update the Platform Account with Credentials
After OAuth is complete, update the carrier account using the carrier_account_id returned in the previous step.
-
platform_account_number: EPA associated with platform rates -
account_number: EPA associated with MRC rates
curl -X PATCH https://api.easypost.com/v2/carrier_accounts/<carrier_account_id> \
-u <api-key>: \
-H 'Content-Type: application/json' \
-d '{
"carrier_account": {
"description": "My USPS Ship Account",
"credentials": {
"account_number": "<Merchant Rate Card EPS #>",
"customer_registration_id": "<CRID>",
"mailer_id": "<MID>",
"returns_mailer_id": "<Returns MID>",
"manifest_id": "<Master/Manifest MID>",
"platform_account_number": "<Platform EPS #>"
}
}
}'Add a USPS Ship Wallet Account (Dashboard)
For detailed instructions on creating and authorizing a USPS Ship Wallet account from the EasyPost Dashboard, see Add a USPS Ship Wallet Account from the Dashboard.
Onboard Child or UTM Users (Optional)
Child or UTM users can be configured to access platform rates.
Create a Platform Account
A USPS Ship platform account can be created using one of the following methods:
-
API: Create a
UspsShipPlatformAccountusing the API (see below). - Dashboard: Create a platform account using the EasyPost Dashboard.
API
- Contact EasyPost to obtain a
shipper_idfor the platform account. - Provide the
shipper_idto the Child or UTM user. - Create a
UspsShipPlatformAccountusing the Child or UTM user’s contact information andshipper_id.
curl -X POST https://api.easypost.com/v2/carrier_accounts \
-u <child-or-utm-user-api-key>: \
-H 'Content-Type: application/json' \
-d '{
"carrier_account": {
"type": "UspsShipPlatformAccount",
"payment_mode": "aggregation",
"description": "",
"reference": "<my-reference>",
"credentials": {
"company_name": "<Company Name>",
"address_street": "<Street>",
"address_city": "<City>",
"address_state": "<State>",
"address_zip": "<ZIP>",
"phone": "<Phone>",
"email": "<Email>",
"shipper_id": "<platform_shipper_id>"
}
}
}'
Once created, the Child or UTM users will have access to platform rates. Authentication is inherited from the Connect eCommerce (CeC) USPS Ship platform account.