API Resources and Operations

Overview

This page lists the API resources alphabetically by resource path (the third column in each table). The resources are alphabetized beginning after the version number. For base URLs, see API Environments. For the OAuth resource, see Generate an OAuth Token.

Addresses

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

Carriers

Description Method Resource Path
Get carrier license GET /v1/carrier/licenseagreements?carrier={carrier}&originCountryCode={two-character-ISO-code}

Countries

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

Merchants

Description Method Resource Path
Deactivate a merchant POST /v2/developers/{developerId}/accounts/{postalReportingNumber}/deactivate
Get merchants GET /v1/developers/{developerId}/merchants
Authorize a merchant POST /v1/developers/{developerId}/merchants/credentials
Register a merchant POST /v2/developers/{developerId}/merchants/registration
Sign up a merchant POST /v1/developers/{developerId}/merchants/signup
Get account balances GET /v1/developers/{developerId}/merchants/{postalReportingNumber}/account-balance
Refill account POST /v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund
Get refill settings GET /v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
Update refill settings POST /v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule
Register Existing Carrier Account POST /v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier}

Rating Services

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

Transaction Reports

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

Manifests

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

Payment

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

Pickups

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

Rates

Description Method Resource Path
Rate package POST /v1/rates

Shipments

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

Tracking

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