Important! This method is only available for Greater-China based sellers with an active eDIS account.
This API allows 3rd party developers in the Greater-China area to process package shipping details.
actual_costs
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getActualCosts | GET | /actual_costs | Retrieves the actual weight and cost for one or more packages. | View getActualCosts - /actual_costs |
address_preference
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createAddressPreference | POST | /address_preference | Creates a shipping address or return shipping address. | View createAddressPreference - /address_preference |
| getAddressPreferences | GET | /address_preference | Retrieves all shipping addresses and return shipping addresses associated with a sellers' eDIS account. | View getAddressPreferences - /address_preference |
agents
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getAgents | GET | /agents | Retrieves the EU Authorized Representative (AR) agent settings associated with an eDIS account. | View getAgents - /agents |
battery_qualifications
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getBatteryQualifications | GET | /battery_qualifications | Retrieves all battery qualifications associated with an eDIS account. | View getBatteryQualifications - /battery_qualifications |
complaint
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createComplaint | POST | /complaint | Creates a complaint against a shipping logistics provider. | View createComplaint - /complaint |
consign_preference
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createConsignPreference | POST | /consign_preference | Creates a pickup, drop-off, or forward deployment address. | View createConsignPreference - /consign_preference |
| getConsignPreferences | GET | /consign_preference | Retrieves all pickup, drop-off, and/or forward deployment addresses associated with a sellers' eDIS account. | View getConsignPreferences - /consign_preference |
dropoff_sites
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getDropoffSites | GET | /dropoff_sites | Retrieves metadata for one or more drop-off site locations associated with an eDIS account. | View getDropoffSites - /dropoff_sites |
handover_sheet
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getHandoverSheet | GET | /handover_sheet | Retrieves the handover sheet for one or more packages in a pickup request. | View getHandoverSheet - /handover_sheet |
labels
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getLabels | GET | /labels | Retrieves shipping labels for one or more packages. | View getLabels - /labels |
package
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| bulkCancelPackages | POST | /package/bulk_cancel_packages | Cancels multiple packages and their tracking numbers. | View bulkCancelPackages - /package/bulk_cancel_packages |
| bulkConfirmPackages | POST | /package/bulk_confirm_packages | Confirm the shipping order for multiple packages. | View bulkConfirmPackages - /package/bulk_confirm_packages |
| bulkDeletePackages | POST | /package/bulk_delete_packages | Delete multiple packages. | View bulkDeletePackages - /package/bulk_delete_packages |
| cancelPackage | POST | /package/{package_id}/cancel | Cancels a package and its associated tracking number. | View cancelPackage - /package/{package_id}/cancel |
| clonePackage | POST | /package/{package_id}/clone | Clones a package for redelivery. | View clonePackage - /package/{package_id}/clone |
| confirmPackage | POST | /package/{package_id}/confirm | Confirm the shipping order for a package. | View confirmPackage - /package/{package_id}/confirm |
| createPackage | POST | /package | Creates a package and its associated tracking and ID number for an order. | View createPackage - /package |
| deletePackage | DELETE | /package/{package_id} | Deletes a canceled package. | View deletePackage - /package/{package_id} |
| getPackage | GET | /package/{package_id} | Retrieves a package based on the provided package ID value. | View getPackage - /package/{package_id} |
| getPackagesByLineItemID | GET | /package/{order_line_item_id}/item | Retrieves one or more packages based on a provided line item ID. | View getPackagesByLineItemID - /package/{order_line_item_id}/item |
services
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getServices | GET | /services | Retrieves shipping service metadata. | View getServices - /services |
tracking
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getTracking | GET | /tracking | Retrieves current tracking event details for a specified package. | View getTracking - /tracking |