account APIv1.4.0

The Account API

The Account API lets sellers create and manage the different business policies associated with their eBay Seller account:

  • Fulfillment policy
  • Payment policy
  • Return policy

The Account API also provides methods that let sellers create and maintain sales tax tables for different tax jurisdictions, opt-in to eBay seller programs, retrieve their shipping rate tables, and check their seller privileges (such as their call rate limits).

This overview covers the following Account API topics:

Technical overview

The Account API has methods that interface with the following resources:

  • fulfillment_policy
  • payment_policy
  • return_policy
  • payments_program
  • privilege
  • program
  • rate_table
  • sales_tax

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.

Create and manage fulfillment policies

Fulfillment polices (previously called "shipping policies") describe the shipping options that a seller offers to their buyers.

Shipping options in each fulfillment policy define the type of the shipping service (such as free, flat-rate, or calculated shipping) being offered by the policy. The policies also list specific shipping carriers and services being offered. Sellers can define both domestic and international shipping services, allowing them to fully customize the fulfillment policies they offer.

Sellers can configure multiple fulfillment policies, where each describes a different set of shipping options. The individual fulfillment policies each targets a marketplaces and item category type, but importantly, sellers can configure multiple fulfillment policies for a single marketplace. This lets you configure a set of shipping options to satisfy the different shipping needs of the items you sell.

Create and manage payment policies

Payment policies define how sellers handle the payments for the items they sell, and the payment types they accept.

Like fulfillment policies, payment policies can be set to specific category types and different marketplaces. Also like fulfillment policies, sellers can create multiple payment policies, giving them flexibility in the policies that they assign to different items.

Create and manage return policies

Return policies define how sellers handle returns, such as how many days a buyer has to return an item and who pays for the return shipping cost.

Like the fulfillment and payment policies, you can create multiple return policies for different category types and marketplaces.

Get the privileges of a seller

Seller privileges cover the rate limits set for an eBay Seller account. Use the getPrivileges method to review the status of an eBay Seller account registration and the privileges assigned to the account.

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 a 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 create shipping rate tables that establish the shipping rates they use to ship items. The rate tables can be referenced in the seller's fulfillment policies, making it easy to update a set of policies by refreshing their rate tables. Use getRateTables to return the 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 might have a different sales tax rate. Canada, India, and the United States are such countries, and you can create sales tax tables with varying tax rates for each jurisdiction into which you sell.

Use the getSalesTaxJurisdictions call in the Metadata API to retrieve a complete list of the jurisdictions for the counties that have multiple sales tax jurisdictions. You can create and manages sales tax tables for the different jurisdictions with the methods in the SALES_TAX resource.

Account API requirements and restrictions

The Account API methods are supported by the following marketplaces:

  • EBAY_AU (Australia)
  • EBAY_CA (Canada)
  • EBAY_US (US)

The getRateTables method also supports getting rate tables created for the Italian marketplace (EBAY_IT).

Note: When creating an Account API business policy, make sure the values your supply in the policy fields are supported by the categories where you list items that reference the policy. See the API Reference documentation for creating the business policies for the guidelines that need to be followed when configuring the business policy fields.