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

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

Print Container Label

POST

/v1/container-manifest

Print Batch Container Labels

POST

/v1/container-manifest/batch?carrier={Id}

Reprint Batch Container Labels

GET

/v1/container-manifest/batch/{batchContainerManifestId}

Countries

Description

Method

Resource Path

List Countries

GET

/v1/countries?carrier={carrier}&originCountryCode={two-character-ISO-code}

Cross-Border

Description

Method

Resource Path

Shopping Cart Quote

POST

/v1/crossborder/checkout/quotes

Retrieve HS Code

POST

/v1/crossborder/hs-classification/items

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

Reprint Manifest

GET

/v1/manifests/{manifestId}

Retry Manifest

GET

/v1/manifests?originalTransactionId={transaction_id}

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

Electronic Delivery

POST

/v1/shipments/{shipmentId}/email

Tracking

Description

Method

Resource Path

Add Tracking Events

POST

/v2/track/events

Track Shipment

GET

/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber