The Account API lets you manage the different business policies that are associated with an eBay seller's account. This includes a seller's payment, fulfillment (shipping), and return policies. Interfaces in the API also allow merchants to opt-in to eBay seller programs, set tax tables for countries that have more than a single tax jurisdiction, and check their seller privileges (such as their selling limits).
This overview covers the following Account API topics:
The Account API has methods that interface with the following resources:
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.
Important! When creating business policies, make sure that the values you supply for the policy are supported by the site the policy targets by making a call GeteBayDetails in the Trading API. GeteBayDetails provides metadata that describes the supported features for each eBay marketplace.
Create and manage fulfillment policies
A seller can have multiple fulfillment policies (previously known as shipping policies), where each policy targets a different marketplace or item category type. eBay assigns the first policy created as the default policy (until another policy is created and designated as the default). Only one policy may be the default at a given time.
Create and manage payment policies
Like fulfillment policies, a seller can create payment policies that they can use to define how they handle item payments. Policies can be set to specific category types and different marketplaces. You can create a default policy for each category type/marketplace pair, making it easy for you to list items with different payment policies, depending on what marketplace you are targeting with the listing.
Create and manage return policies
Return policies define how you handle returns. Like the fulfillment and payment policies, you can create different return policies, and associate them with the different category types and marketplaces to which you sell. Starting with v1.2.0, you can specify how to handle international returns if they differ from your domestic return policies.
Get the privileges of a seller
Seller privileges cover the limits eBay sets for your account. Using the getPrivileges call, you can also review the status of your eBay Seller Account registration.
Opt in to or out of seller programs
As an eBay seller, you can opt-in to the different seller programs offed by eBay.
Currently eBay offers two programs:
- Out of Stock Control - Lets eBay help you manage your stock, and update your listings when an item of yours goes out of stock.
- Selling Policy Management - Lets you automatically use the business policies that you create in your item listings.
Get the seller's status on a payments program
The getPaymentsProgram method returns the status of whether or not the seller is opted-in to the payments program specified in the request. Currently, the only payments program available is eBay Payments, a program that eBay offers as a way to transfer funds and complete transactions between buyers and sellers.
Retrieve the shipping rate tables created by the seller
Sellers can now create a set of shipping rate tables that established the different rates that they use to ship their inventory to different destinations. Use getRateTables to return the full set of rate tables configured by the seller.
Create and manage sales tax tables by jurisdiction
While most countries have just a single sales tax rate for the entire country, various countries have multiple sales tax jurisdictions, where each jurisdiction might have a different sales tax rate than the other jurisdictions. Canada, India, and the United States are such countries, and you can create sales tax tables with varying tax rates for each jurisdiction you sell to within the countries with multiple sales tax jurisdictions.
Use the getSalesTaxJurisdictions call in the Metadata API to retrieve a complete list of the different jurisdictions for the counties that have multiple sales tax jurisdictions. Then use the calls that target the SALES_TAX resource to create and manage your sales tax tables.
Account API requirements and restrictions
The Account API is supported by eBay accounts in the following marketplaces:
The getRateTables method is currently available only on the
EBAY_US (US) and
EBAY_AU (Australia) marketplaces.