Open documentation ↗Overview
The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information. <br/><br/>For details on the availability of the methods in this API, see <a href="/api-docs/sell/account/overview.html#requirements">Account API requirements and restrictions</a>.
Account API is a shopping API from ebay.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 36 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Shopping
- Version
- v1.9.0
- Endpoints
- 36
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-05
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /advertising_eligibility | This method allows developers to check the seller eligibility status for eBay advertising programs. |
| GET | /custom_policy/ | This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.<br/> <br/> <span class |
| POST | /custom_policy/ | This method creates a new custom policy in which a seller specifies their terms for complying with local governmental regulations. <br/><br/>Two Custom Policy t |
| GET | /custom_policy/{custom_policy_id} | This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.<br/> <br/> <span class="table |
| PUT | /custom_policy/{custom_policy_id} | This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace. This method overwrites the p |
| GET | /fulfillment_policy | This method retrieves all the fulfillment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. <br/><br/> |
| POST | /fulfillment_policy/ | This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipme |
| GET | /fulfillment_policy/get_by_policy_name | This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy <code>name</code> and its associated <code>marketpla |
| GET | /fulfillment_policy/{fulfillmentPolicyId} | This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the <b>fulfillmentPolicyId</b> path p |
| PUT | /fulfillment_policy/{fulfillmentPolicyId} | This method updates an existing fulfillment policy. Specify the policy you want to update using the <b>fulfillment_policy_id</b> path parameter. Supply a comple |
| DELETE | /fulfillment_policy/{fulfillmentPolicyId} | This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the <b>fulfillmentPolicyId</b> path parameter. |
| GET | /kyc | <span class="tablenote"><b>Note:</b>This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for e |
| GET | /payment_policy | This method retrieves all the payment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. <br/><br/><b>M |
| POST | /payment_policy | This method creates a new payment policy where the policy encapsulates seller's terms for order payments. <br/><br/>Each policy targets a specific eBay marketp |
| GET | /payment_policy/get_by_policy_name | This method retrieves the details of a specific payment policy. Supply both the policy <code>name</code> and its associated <code>marketplace_id</code> in the r |
| GET | /payment_policy/{payment_policy_id} | This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the <b>paymentPolicyId</b> path parameter |
| PUT | /payment_policy/{payment_policy_id} | This method updates an existing payment policy. Specify the policy you want to update using the <b>payment_policy_id</b> path parameter. Supply a complete polic |
| DELETE | /payment_policy/{payment_policy_id} | This method deletes a payment policy. Supply the ID of the policy you want to delete in the <b>paymentPolicyId</b> path parameter. |
| GET | /payments_program/{marketplace_id}/{payments_program_type} | <span class="tablenote"><b>Note:</b> This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkou |
| GET | /payments_program/{marketplace_id}/{payments_program_type}/onboarding | <span class="tablenote"><b>Note:</b> This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkou |
| GET | /privilege | This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details |
| GET | /program/get_opted_in_programs | This method gets a list of the seller programs that the seller has opted-in to. |
| POST | /program/opt_in | This method opts the seller in to an eBay seller program. Refer to the <a href="/api-docs/sell/account/overview.html#opt-in" target="_blank">Account API overvie |
| POST | /program/opt_out | This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the < |
| GET | /rate_table | This method retrieves a seller's <i>shipping rate tables</i> for the country specified in the <b>country_code</b> query parameter. If you call this method witho |
| GET | /return_policy | This method retrieves all the return policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter. <br/><br/><b>Ma |
| POST | /return_policy | This method creates a new return policy where the policy encapsulates seller's terms for returning items. <br/><br/>Each policy targets a specific marketplace, |
| GET | /return_policy/get_by_policy_name | This method retrieves the details of a specific return policy. Supply both the policy <code>name</code> and its associated <code>marketplace_id</code> in the re |
| GET | /return_policy/{return_policy_id} | This method retrieves the complete details of the return policy specified by the <b>returnPolicyId</b> path parameter. |
| PUT | /return_policy/{return_policy_id} | This method updates an existing return policy. Specify the policy you want to update using the <b>return_policy_id</b> path parameter. Supply a complete policy |
| DELETE | /return_policy/{return_policy_id} | This method deletes a return policy. Supply the ID of the policy you want to delete in the <b>returnPolicyId</b> path parameter. |
| GET | /sales_tax | Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax |
| GET | /sales_tax/{countryCode}/{jurisdictionId} | This call gets the current sales tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the <b>countryCode</b> and <b>juris |
| PUT | /sales_tax/{countryCode}/{jurisdictionId} | This method creates or updates a sales tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: <b>c |
| DELETE | /sales_tax/{countryCode}/{jurisdictionId} | This call deletes a sales tax table entry for a jurisdiction. Specify the jurisdiction to delete using the <b>countryCode</b> and <b>jurisdictionId</b> path par |
| GET | /subscription | This method retrieves a list of subscriptions associated with the seller account. |
Questions
Does the Account API API need an API key?
Yes. The Account API API uses OAuth authentication; the documentation explains how to get credentials.
Does the Account API API support HTTPS?
Yes, the Account API API is served over HTTPS.
How many endpoints does the Account API API have?
Its OpenAPI description lists 36 endpoints in version v1.9.0. All of them are shown on this page.
What are alternatives to the Account API API?
Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.
Similar shopping APIs
Compare alternatives →Etsy
ShoppingManage shop and interact with listings
OAuth
eBay
ShoppingSell and Buy on eBay
OAuth
Flipkart Marketplace
ShoppingProduct listing management, Order Fulfilment in the Flipkart Marketplace
OAuthCORS
Inventory Management
ShoppingMaintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.
No auth7 endpoints
Intel Product Catalogue Service
ShoppingThis is the documentation for PIM Micro services. In order to use this tool you need to have Basic Auth credentials and a client id. If you dont have one, please make sure to request one by sending an email to the PIM MS team: [[email protected]](mailto:[email protected]?subject=PIMServices)
API key4 endpoints
Item API
ShoppingPlease make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.
No auth6 endpoints
Listed from APIs.guru (CC0).