API Resources for the Shipping and Accounts APIs¶
Overview¶
This page lists all resources for the Shipping and Accounts APIs. For base URLs, see API Environments. For the OAuth resource, see Generate an OAuth Token.
The resources below are listed alphabetically by their resource paths, beginning after the version number.
Addresses¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/addresses/verify |
|
POST |
/v1/addresses/verify-suggest |
Carrier¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/carrier-facility |
|
GET |
/v1/carrier/license-agreements?carrier={carrier}&originCountryCode={two-character-ISO-code} |
Container¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/container-manifest |
Cross-Border¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/crossborder/checkout/quotes |
|
POST |
/v1/crossborder/hs-classification/items |
Countries¶
Description |
Method |
Resource Path |
---|---|---|
GET |
/v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code} |
Developers (Merchant Accounts)¶
Description |
Method |
Resource Path |
---|---|---|
GET |
/v1/developers/{developerId}/merchants |
|
POST |
/v1/developers/{developerId}/merchants/credentials |
|
POST |
/v2/developers/{developerId}/merchants/registration |
|
GET |
/v1/developers/{developerId}/merchants/{postalReportingNumber}/account-balance |
|
POST |
/v1/developers/{developerId}/merchants/{postalReportingNumber}/account/fund |
|
GET |
/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule |
|
POST |
/v1/developers/{developerId}/merchants/{postalReportingNumber}/autorefillrule |
|
POST |
/v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier} |
Information (Carrier Rules)¶
Description |
Method |
Resource Path |
---|---|---|
GET |
/v1/information/rules/rating-services?carrier={carrier}&originCountryCode={XX}&destinationCountryCode={YY} |
Ledger (Transaction Reports)¶
Description |
Method |
Resource Path |
---|---|---|
GET |
/v4/ledger/developers/{developerId}/transactions/archived |
|
GET |
/v4/ledger/developers/{developerId}/transactions/reports |
Manifests¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/manifests |
|
GET |
/v1/manifests?originalTransactionId={transaction_id} |
|
GET |
/v1/manifests/{manifestId} |
Pickups¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/pickups/schedule |
|
POST |
/v1/pickups/{pickupId}/cancel |
Rates¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/rates |
Shipments¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/shipments |
|
GET |
/v1/shipments?originalTransactionId={transaction_id}&carrier={carrier} |
|
GET |
/v1/shipments/{shipmentId}?carrier={carrier} |
|
DELETE |
/v1/shipments/{shipmentId}?carrier={carrier}&cancelInitiator=SHIPPER |
Tracking¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v2/track/events |
|
GET |
/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber |