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.
rate_table
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getRateTable | GET | /rate_table/{rate_table_id} | Retrieves details of a specific shipping rate table. | View getRateTable - /rate_table/{rate_table_id} |
| updateShippingCost | POST | /rate_table/{rate_table_id}/update_shipping_cost | Updates one or more shipping rates for a specific shipping rate table. | View updateShippingCost - /rate_table/{rate_table_id}/update_shipping_cost |
payout_settings
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPayoutSettings | GET | /payout_settings | Retrieves payout percentages and unique IDs for accounts configured to receive seller payouts. | View getPayoutSettings - /payout_settings |
| updatePayoutPercentage | POST | /payout_settings/update_percentage | Updates the split-payout percentage for two payout instruments for sellers in mainland China. | View updatePayoutPercentage - /payout_settings/update_percentage |
combined_shipping_rules
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createCalculatedShippingRules | POST | /combined_shipping_rules/create_calculated_shipping_rules | Creates calculated shipping rules that determine combined shipping costs based on item attributes (such as weight, dimensions), for the seller's account. | View createCalculatedShippingRules - /combined_shipping_rules/create_calculated_shipping_rules |
| createFlatShippingRules | POST | /combined_shipping_rules/create_flat_shipping_rules | Creates flat-rate rules that apply standard that apply standard combined shipping costs for a seller's listings. | View createFlatShippingRules - /combined_shipping_rules/create_flat_shipping_rules |
| createPromotionalShippingRule | POST | /combined_shipping_rules/create_promotional_shipping_rule | Defines promotional shipping rules, such as discounts or free-shipping thresholds. | View createPromotionalShippingRule - /combined_shipping_rules/create_promotional_shipping_rule |
| getCombinedShippingRules | GET | /combined_shipping_rules | Retrieves all combined shipping rule configurations defined for the seller. | View getCombinedShippingRules - /combined_shipping_rules |
| updateCalculatedShippingRules | POST | /combined_shipping_rules/update_calculated_shipping_rules | Updates a previously defined calculated shipping rules. | View updateCalculatedShippingRules - /combined_shipping_rules/update_calculated_shipping_rules |
| updateCombinedPayments | POST | /combined_shipping_rules/update_combined_payments | Configures or modifies combined payment settings that determine how unpaid orders can be merged. | View updateCombinedPayments - /combined_shipping_rules/update_combined_payments |
| updateFlatShippingRules | POST | /combined_shipping_rules/update_flat_shipping_rules | Updates existing flat-rate shipping rules. | View updateFlatShippingRules - /combined_shipping_rules/update_flat_shipping_rules |
| updatePromotionalShippingRule | POST | /combined_shipping_rules/update_promotional_shipping_rule | Updates a promotional shipping rule to adjust discount thresholds, eligibility criteria, or duration for the seller. | View updatePromotionalShippingRule - /combined_shipping_rules/update_promotional_shipping_rule |
user_preferences
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getUserPreferences | GET | /user_preferences | Retrieves the seller's preferences for a specific eBay marketplace. | View getUserPreferences - /user_preferences |
| setUserPreferences | PATCH | /user_preferences | Modifies one or more preferences for a seller on a specific marketplace. | View setUserPreferences - /user_preferences |