account APIv1.6.0

The Account API

The Account API is used by sellers to:

  • create and manage business policies used with their listings to set/control payment, shipping, and return policy settings/values
  • create and manage sales tax rates for different tax jurisdictions
  • retrieve various other seller account settings including eBay managed payments eligibility, selling limits, shipping rate tables, and other selling features

This overview covers the following Account API topics:

Technical overview

The Account API provides methods in each of the following resources:

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

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 marketplace 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 selling limits set for 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, these programs include:

  • Out of Stock Control - eBay will keep you fixed-price listings active even when you temporarily run out of inventory for the product.
  • Selling Policy Management - Enables the use of business policies for your selling account

Get the seller's status for eBay managed payments

The getPaymentsProgram method returns the status of whether or not a seller is opted-in to the eBay managed payments.

The getPaymentsProgramOnboarding method retrieves the seller’s onboarding status for managed payments, and provides the next step(s) in the onboarding process for eligible sellers.

The getKYC method allows a managed payments seller to discover any 'Know Your Customer' (KYC) check action items. Action items may include providing company details, personal details, or bank account details.

The getPaymentsProgram method returns the status of whether or not a seller is opted-in to the eBay managed payments specified in the request. Currently, the only eBay managed payments available is eBay Payments, a program that eBay offers as a way to transfer funds and complete transactions between buyers and sellers.

The getPaymentsProgramOnboarding method retrieves the seller’s onboarding status and, for eligible sellers, provides the next step(s) in the onboarding process.

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 is supported by all eBay marketplaces.

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 Account API Reference documentation for the guidelines that you need to follow when configuring the business policy fields.