eBay

Account API

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Account API 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. For details on the availability of the methods in this API, see Account API requirements and restrictions .

Endpoints 36

advertising_eligibility

  • GETgetAdvertisingEligibility/advertising_eligibility?program_types=stringThis method allows developers to check the seller eligibility status for eBay advertising programs.

custom_policy

  • GETgetCustomPolicies/custom_policy/?policy_types=stringThis method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter for the selected eBay marketplace.<br/> <br/> <span…
  • POSTcreateCustomPolicy/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…
  • GETgetCustomPolicy/custom_policy/:custom_policy_idThis method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter for the selected eBay marketplace.<br/> <br/> <span…
  • PUTupdateCustomPolicy/custom_policy/:custom_policy_idThis method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter for the selected marketplace. This method overwrites the…

fulfillment_policy

  • GETgetFulfillmentPolicies/fulfillment_policy?marketplace_id=stringThis method retrieves all the fulfillment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter.…
  • POSTcreateFulfillmentPolicy/fulfillment_policy/This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the…
  • GETgetFulfillmentPolicyByName/fulfillment_policy/get_by_policy_name?marketplace_id=string&name=stringThis method retrieves the details for a specific fulfillment policy. In the request, supply both the policy <code>name</code> and its associated…
  • GETgetFulfillmentPolicy/fulfillment_policy/:fulfillmentPolicyIdThis 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…
  • PUTupdateFulfillmentPolicy/fulfillment_policy/:fulfillmentPolicyIdThis method updates an existing fulfillment policy. Specify the policy you want to update using the <b>fulfillment_policy_id</b> path parameter. Supply a…
  • DELETEdeleteFulfillmentPolicy/fulfillment_policy/:fulfillmentPolicyIdThis method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the <b>fulfillmentPolicyId</b> path parameter.

kyc

  • GETgetKYC/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…

payment_policy

  • GETgetPaymentPolicies/payment_policy?marketplace_id=stringThis method retrieves all the payment policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter.…
  • POSTcreatePaymentPolicy/payment_policyThis method creates a new payment policy where the policy encapsulates seller's terms for order payments. <br/><br/>Each policy targets a specific eBay…
  • GETgetPaymentPolicyByName/payment_policy/get_by_policy_name?marketplace_id=string&name=stringThis 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…
  • GETgetPaymentPolicy/payment_policy/:payment_policy_idThis 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…
  • PUTupdatePaymentPolicy/payment_policy/:payment_policy_idThis 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…
  • DELETEdeletePaymentPolicy/payment_policy/:payment_policy_idThis method deletes a payment policy. Supply the ID of the policy you want to delete in the <b>paymentPolicyId</b> path parameter.

payments_program

  • GETgetPaymentsProgram/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…

onboarding

  • GETgetPaymentsProgramOnboarding/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…

privilege

  • GETgetPrivileges/privilegeThis 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…

program

  • GETgetOptedInPrograms/program/get_opted_in_programsThis method gets a list of the seller programs that the seller has opted-in to.
  • POSToptInToProgram/program/opt_inThis 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…
  • POSToptOutOfProgram/program/opt_outThis 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…

rate_table

  • GETgetRateTables/rate_table?country_code=stringThis 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…

return_policy

  • GETgetReturnPolicies/return_policy?marketplace_id=stringThis method retrieves all the return policies configured for the marketplace you specify using the <code>marketplace_id</code> query parameter.…
  • POSTcreateReturnPolicy/return_policyThis method creates a new return policy where the policy encapsulates seller's terms for returning items. <br/><br/>Each policy targets a specific…
  • GETgetReturnPolicyByName/return_policy/get_by_policy_name?marketplace_id=string&name=stringThis 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…
  • GETgetReturnPolicy/return_policy/:return_policy_idThis method retrieves the complete details of the return policy specified by the <b>returnPolicyId</b> path parameter.
  • PUTupdateReturnPolicy/return_policy/:return_policy_idThis 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…
  • DELETEdeleteReturnPolicy/return_policy/:return_policy_idThis method deletes a return policy. Supply the ID of the policy you want to delete in the <b>returnPolicyId</b> path parameter.

sales_tax

  • GETgetSalesTaxes/sales_tax?country_code=stringUse 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…
  • GETgetSalesTax/sales_tax/:countryCode/:jurisdictionIdThis call gets the current sales tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the <b>countryCode</b> and…
  • PUTcreateOrReplaceSalesTax/sales_tax/:countryCode/:jurisdictionIdThis 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:…
  • DELETEdeleteSalesTax/sales_tax/:countryCode/:jurisdictionIdThis 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…

subscription

  • GETgetSubscription/subscription?limit=string&continuation_token=stringThis method retrieves a list of subscriptions associated with the seller account.

API details

Base URL
https://api.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
Operations
36 operations on 24 pathsGET 21POST 6PUT 5DELETE 4
Main resources
fulfillment_policy 6payment_policy 6return_policy 6custom_policy 4sales_tax 4program 3advertising_eligibility 1kyc 1onboarding 1payments_program 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1.9.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Account API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Account API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getAdvertisingEligibility” (GET /advertising_eligibility?program_types=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Account API?

The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined… It is listed under E-commerce and has 36 endpoints.

Who publishes the Account API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Account API?

Requests go to https://api.ebay.com{basePath}. Endpoint paths are added to this base URL.

How do I authenticate with the Account API?

With OAuth 2.0 (authorization code flow) with 2 scopes.

How many endpoints does the Account API have?

36 operations on 24 paths (21 GET, 6 POST, 5 PUT, 4 DELETE). The largest groups are fulfillment_policy, payment_policy, return_policy, custom_policy.

Is forking the Account API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.