Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

This API allows sellers to retrieve and manage their custom shipping rate tables. In addition, this API also provides sellers in mainland China methods to configure split-payouts between two separate payment instruments.


Method NameHTTP MethodPathSummarySamples
getRateTableGET/rate_table/{rate_table_id}Returns details about the seller's shipping rate table specified by a rate table ID.View getRateTable - /rate_table/{rate_table_id}
updateShippingCostPOST/rate_table/{rate_table_id}/update_shipping_costUpdates the shippingCost and/or additionalCost information for a seller's shipping rate table specified by a rate table ID.View updateShippingCost - /rate_table/{rate_table_id}/update_shipping_cost


Method NameHTTP MethodPathSummarySamples
getPayoutSettingsGET/payout_settingsReturns details about a seller's payment instruments for seller payouts in Mainland China.View getPayoutSettings - /payout_settings
updatePayoutPercentagePOST/payout_settings/update_percentageAllows a seller to set or update the split-payout percentage, out of 100, for two payout instruments.View updatePayoutPercentage - /payout_settings/update_percentage