Note: Looking for the Account API v1 documents? They are available here.

The Account API v2 provides sellers with advanced methods for managing their shipping rate tables. Using these methods, sellers can:

  • retrieve a shipping rate table specified by a rate table ID;
  • quickly update shipping cost information for a shipping rate table specified by the rate table ID.

In addition to these methods, the Account API v2 also provides sellers in mainland China methods to configure split payouts between two separate payment instruments, such as between a bank account and Payoneer.

For more information on setting up and configuring split payouts, see Mainland China Split Payout Playbook.

Technical overview

The Account API v2 provides methods in the following resources:

  • rate_table
  • payout_settings

See the Business use cases section that follows for the details on how you can use these resources.

Business use cases

This section outlines the high-level use cases addressed by this API.

Manage shipping rate tables created by the seller

Sellers can create shipping rate tables that establish the shipping rates they use to ship items which can then be referenced in their fulfillment policies.

The getRateTable method returns the shipping rate table specified by the rate table ID.

The updateShippingCost method is used to quickly update shipping cost information for a shipping rate table specified by the rate table ID.

Configure split-payouts for two payment instruments (for mainland China sellers only)

Sellers in mainland China can split payouts between two separate payment instruments, such as a bank account and Payoneer.

The getPayoutSettings method returns the instrumentId for a sellers available payout instruments.

The updatePayoutPercentage method uses the instrumentId to make changes to the payout split between two payout instrument.

Account API v2 requirements and restrictions

The Account API v2 is currently supported by the following eBay marketplaces:

  • EBAY_AU

  • EBAY_CA

  • EBAY_DE

  • EBAY_ES

  • EBAY_FR

  • EBAY_GB

  • EBAY_IT

  • EBAY_US