API Resources

PB Shipping APIs Resources

This page lists the API resources alphabetically by resource path, beginning after the version number. For the base URLs for the sandbox and production environments, see API Environments. For OAuth, see Generate an OAuth Token.

Addresses

Description Method Path
Verify address POST /v1/addresses/verify
Suggest address POST /v1/addresses/verify-suggest

Countries

Description Method Path
List countries GET /v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code}

Merchants

Description Method Path
Deactivate merchant POST /v2/developers/{developerId}/accounts/{postalReportingNumber}/deactivate
Get merchants GET /v1/developers/{developerId}/merchants
Authorize a merchant POST /v1/developers/{developerId}/merchants/credentials
Sign up a merchant POST /v1/developers/{developerId}/merchants/signup
Get refill settings GET /v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
Update refill settings POST /v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
Get account balances GET /v1/developers/{developerId}/merchants/{postalReportingNumber}/account-balance
Register a merchant POST /v2/developers/{developerId}/merchants/registration

Rating Services

Description Method Path
Get carrier rules GET /v1/information/rules/rating-services?carrier={carrier}&originCountryCode={XX}&destinationCountryCode={YY}

Transaction Reports

Description Method Path
List transactions GET /v2/ledger/developers/{developerId}/transactions/reports

Manifests

Description Method Path
Create manifest POST /v1/manifests
Reprint manifest GET /v1/manifests/{manifestId}
Retry manifest GET /v1/manifests?originalTransactionId={transaction_id}

Payment

Description Method Path
Retrieve payment iframe URL POST /v1/payment/render

Pickups

Description Method Path
Schedule pickup POST /v1/pickups/schedule
Cancel pickup POST /v1/pickups/{pickupId}/cancel

Rates

Description Method Path
Rate package POST /v1/rates

Shipments

Description Method Path
Create shipment POST /v1/shipments
Reprint shipment GET /v1/shipments/{shipmentId}?carrier={carrier}
Retry shipment GET /v1/shipments?originalTransactionId={transaction_id}&carrier={carrier}
Void shipment DELETE /v1/shipments/{shipmentId}

Tracking

Description Method Path
Track shipment GET /v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber&carrier=USPS