API Resources for the Shipping APIs¶
Overview¶
This page lists all resources for the Global Ecommerce Shipping APIs. For base URLs, see API Environments. For authentication, see Generate an OAuth Token. For resources for the Merchant Accounts APIs, see Manage Merchant Accounts.
Resources are listed alphabetically by Resource Path, 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 |
|
POST |
/v1/container-manifest/batch?carrier={Id} |
|
GET |
/v1/container-manifest/batch/{batchContainerManifestId} |
Countries¶
Description |
Method |
Resource Path |
---|---|---|
GET |
/v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code} |
Cross-Border¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v1/crossborder/checkout/quotes |
|
POST |
/v1/crossborder/hs-classification/items |
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/{manifestId} |
|
GET |
/v1/manifests?originalTransactionId={transaction_id} |
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 |
|
POST |
/v1/shipments/{shipmentId}/email |
Tracking¶
Description |
Method |
Resource Path |
---|---|---|
POST |
/v2/track/events |
|
GET |
/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber |