API Resources¶

Overview¶

This page lists all API resources alphabetically by their Resource Paths, as listed in column 3. The resource paths 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 an Address	POST	/v1/addresses/verify
Suggest an Address	POST	/v1/addresses/verify-suggest

Carrier¶

Description	Method	Resource Path
Find Carrier Facility	POST	/v1/carrier-facility
Get Carrier License	GET	/v1/carrier/license-agreements?carrier={carrier}&originCountryCode={two-character-ISO-code}

Container¶

Description	Method	Resource Path
Create Container Label	POST	/v1/container-manifest

Cross-Border¶

Description	Method	Resource Path
Shopping Cart Quote	POST	/v1/crossborder/checkout/quotes
Retrieve HS Code	POST	/v1/crossborder/hs-classification/items

Countries¶

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

Developers (Merchant Accounts)¶

Description	Method	Resource Path
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
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
Add a Carrier Account	POST	/v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier}

Information (Carrier Rules)¶

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

Ledger (Transaction Reports)¶

Description	Method	Resource Path
Get Archived Reports	GET	/v4/ledger/developers/{developerId}/transactions/archived
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}

Pickups¶

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

Rates¶

Description	Method	Resource Path
Rate Parcel	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}?carrier={carrier}&cancelInitiator=SHIPPER

Tracking¶

Description	Method	Resource Path
Add Tracking Events	POST	/v2/track/events
Track Shipment	GET	/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber