eBay Account API

naftiko: 1.0.0-alpha2
info:
  label: eBay Account API
  description: 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>.
  tags:
  - Ebay
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: ebay
    baseUri: https://api.ebay.com/sell/account/v1
    description: eBay Account API HTTP API.
    authentication:
      type: bearer
      token: '{{EBAY_TOKEN}}'
    resources:
    - name: custom-policy
      path: /custom_policy/
      operations:
      - name: getcustompolicies
        method: GET
        description: This method retrieves the list of custom policies specified by the <b>policy_types</b> query parameter.<br><br><span
          class="tablenote"><b>Note:</b> Custom policies are no longer coupled with a specific eBay marketplace, so the <b>EBAY-C-MAR
        inputParameters:
        - name: policy_types
          in: query
          type: string
          description: This query parameter specifies the type of custom policies to be returned.<br><br>Multiple policy types
            may be requested in a single call by providing a comma-d
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcustompolicy
        method: POST
        description: '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 types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li>
          <li>Tak'
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: custom-policy-custom-policy-id
      path: /custom_policy/{custom_policy_id}
      operations:
      - name: getcustompolicy
        method: GET
        description: This method retrieves the custom policy specified by the <b>custom_policy_id</b> path parameter.<br><br><span
          class="tablenote"><b>Note:</b> Custom policies are no longer coupled with a specific eBay marketplace, so the <b>EBAY-C-MARKETPLAC
        inputParameters:
        - name: custom_policy_id
          in: path
          type: string
          required: true
          description: This path parameter is the unique identifier of the custom policy to retrieve.<br><br> This ID can
            be retrieved for a custom policy by using the <a href="/api-d
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecustompolicy
        method: PUT
        description: This method updates an existing custom policy specified by the <b>custom_policy_id</b> path parameter.
          This method overwrites the policy's <b>Name</b>, <b>Label</b>, and <b>Description</b> fields. Therefore, the complete,
          current text of al
        inputParameters:
        - name: custom_policy_id
          in: path
          type: string
          required: true
          description: This path parameter is the unique identifier of the custom policy to retrieve.<br><br> This ID can
            be retrieved for a custom policy by using the <a href="/api-d
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: fulfillment-policy
      path: /fulfillment_policy/
      operations:
      - name: createfulfillmentpolicy
        method: POST
        description: This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling
          item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. <br><br>Each
          policy targets a speci
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: fulfillment-policy-fulfillmentpolicyid
      path: /fulfillment_policy/{fulfillmentPolicyId}
      operations:
      - name: getfulfillmentpolicy
        method: GET
        description: 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 parameter.
        inputParameters:
        - name: fulfillmentPolicyId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the fulfillment policy you want to retrieve.<br><br> This ID
            can be retrieved for a fulfillment policy by using the <a h
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatefulfillmentpolicy
        method: PUT
        description: 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 complete policy payload with the updates you want to make; this call overwrites the ex
        inputParameters:
        - name: fulfillmentPolicyId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the fulfillment policy you want to update.<br><br>This ID can
            be retrieved for a specific fulfillment policy by using th
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletefulfillmentpolicy
        method: DELETE
        description: This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the <b>fulfillmentPolicyId</b>
          path parameter.
        inputParameters:
        - name: fulfillmentPolicyId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the fulfillment policy to delete.<br><br> This ID can be retrieved
            for a fulfillment policy by using the <a href="/api-d
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: fulfillment-policy
      path: /fulfillment_policy
      operations:
      - name: getfulfillmentpolicies
        method: GET
        description: 'This method retrieves all the fulfillment policies configured for the marketplace you specify using
          the <code>marketplace_id</code> query parameter. <br><br><b>Marketplaces and locales</b> <br><br>Get the correct
          policies for a marketplace '
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation
            help, refer to eBay API documentation at https://de
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: fulfillment-policy-get-by-policy-name
      path: /fulfillment_policy/get_by_policy_name
      operations:
      - name: getfulfillmentpolicybyname
        method: GET
        description: This method retrieves the details for a specific fulfillment policy. In the request, supply both the
          policy <code>name</code> and its associated <code>marketplace_id</code> as query parameters. <br><br><b>Marketplaces
          and locales</b> <br><b
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation
            help, refer to eBay API documentation at https://deve
        - name: name
          in: query
          type: string
          required: true
          description: This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.<br><br>This
            value can be retrieved for a fulfillment poli
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payment-policy
      path: /payment_policy
      operations:
      - name: getpaymentpolicies
        method: GET
        description: This method retrieves all the payment policies configured for the marketplace you specify using the <code>marketplace_id</code>
          query parameter. <br><br><b>Marketplaces and locales</b> <br><br>Get the correct policies for a marketplace that
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation
            help, refer to eBay API documentation at https://de
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createpaymentpolicy
        method: POST
        description: 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 marketplace and category group, and you can create multiple policies
          for each combination.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payment-policy-payment-policy-id
      path: /payment_policy/{payment_policy_id}
      operations:
      - name: getpaymentpolicy
        method: GET
        description: 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.
        inputParameters:
        - name: payment_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the payment policy you want to retrieve. <br><br> This ID can
            be retrieved for a payment policy by using the <a href="/a
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatepaymentpolicy
        method: PUT
        description: 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 policy payload with the updates you want to make; this call overwrites the existing
          p
        inputParameters:
        - name: payment_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the payment policy you want to update. <br><br> This ID can
            be retrieved for a payment policy by using the <a href="/api
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletepaymentpolicy
        method: DELETE
        description: This method deletes a payment policy. Supply the ID of the policy you want to delete in the <b>paymentPolicyId</b>
          path parameter.
        inputParameters:
        - name: payment_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the unique identifier of the payment policy you want to delete.<br><br>
            This ID can be retrieved for a payment policy by using the
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payment-policy-get-by-policy-name
      path: /payment_policy/get_by_policy_name
      operations:
      - name: getpaymentpolicybyname
        method: GET
        description: 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 request query parameters. <br><br><b>Marketplaces and locales</b>
          <br><br>Get the
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation
            help, refer to eBay API documentation at https://deve
        - name: name
          in: query
          type: string
          required: true
          description: This query parameter specifies the seller-defined name of the payment policy you want to retrieve.<br><br>
            This value can be retrieved for a payment policy by u
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payments-program-marketplace-id-payments-program
      path: /payments_program/{marketplace_id}/{payments_program_type}
      operations:
      - name: getpaymentsprogram
        method: GET
        description: <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 checkout flow.</span><br>This method returns whether or not the user
          is opted-in to the
        inputParameters:
        - name: marketplace_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve
            the seller's status.
        - name: payments_program_type
          in: path
          type: string
          required: true
          description: This path parameter specifies the payments program whose status is returned by the call.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payments-program-marketplace-id-payments-program
      path: /payments_program/{marketplace_id}/{payments_program_type}/onboarding
      operations:
      - name: getpaymentsprogramonboarding
        method: GET
        description: <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 checkout flow.</span><br>This method retrieves a seller's onboarding
          status for a payme
        inputParameters:
        - name: marketplace_id
          in: path
          type: string
          required: true
          description: The eBay marketplace ID associated with the onboarding status to retrieve.
        - name: payments_program_type
          in: path
          type: string
          required: true
          description: The type of payments program whose status is returned by the method.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: privilege
      path: /privilege
      operations:
      - name: getprivileges
        method: GET
        description: 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 of their site-wide <b>sellingLimt</b> (the amount and quantity
          they can sell on
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: program-get-opted-in-programs
      path: /program/get_opted_in_programs
      operations:
      - name: getoptedinprograms
        method: GET
        description: This method gets a list of the seller programs that the seller has opted-in to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: program-opt-in
      path: /program/opt_in
      operations:
      - name: optintoprogram
        method: POST
        description: 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 overview</a> for information about available eBay seller programs.<br><br><span class="
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: program-opt-out
      path: /program/opt_out
      operations:
      - name: optoutofprogram
        method: POST
        description: 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 <b>getOptedInPrograms</b> call.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rate-table
      path: /rate_table
      operations:
      - name: getratetables
        method: GET
        description: 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 without specifying a country code, the call returns all of the seller's
          shipping rate
        inputParameters:
        - name: country_code
          in: query
          type: string
          description: This query parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html
            " title="https://www.iso.org " target="_blank">ISO 3166</
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: return-policy
      path: /return_policy
      operations:
      - name: getreturnpolicies
        method: GET
        description: 'This method retrieves all the return policies configured for the marketplace you specify using the <code>marketplace_id</code>
          query parameter. <br><br><b>Marketplaces and locales</b> <br><br>Get the correct policies for a marketplace that '
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For
            implementation help, refer to eBay API documentation at ht
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createreturnpolicy
        method: POST
        description: 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, and you can create multiple policies for each marketplace. Return
          policies are not
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: return-policy-return-policy-id
      path: /return_policy/{return_policy_id}
      operations:
      - name: getreturnpolicy
        method: GET
        description: This method retrieves the complete details of the return policy specified by the <b>returnPolicyId</b>
          path parameter.
        inputParameters:
        - name: return_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the unique identifier of the return policy you want to retrieve. <br><br>
            This ID can be retrieved for a return policy by using th
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatereturnpolicy
        method: PUT
        description: 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 payload with the updates you want to make; this call overwrites the existing
          pol
        inputParameters:
        - name: return_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the return policy you want to update. <br><br> This ID can
            be retrieved for a return policy by using the <a href="/api-d
        - name: Content-Type
          in: header
          type: string
          required: true
          description: 'This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>. <br><br> For more information, '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletereturnpolicy
        method: DELETE
        description: This method deletes a return policy. Supply the ID of the policy you want to delete in the <b>returnPolicyId</b>
          path parameter.
        inputParameters:
        - name: return_policy_id
          in: path
          type: string
          required: true
          description: This path parameter specifies the unique identifier of the return policy you want to delete.<br><br>
            This ID can be retrieved for a return policy by using the <
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: return-policy-get-by-policy-name
      path: /return_policy/get_by_policy_name
      operations:
      - name: getreturnpolicybyname
        method: GET
        description: '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 request query parameters. <br><br><b>Marketplaces and locales</b>
          <br><br>Get the '
        inputParameters:
        - name: marketplace_id
          in: query
          type: string
          required: true
          description: This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For
            implementation help, refer to eBay API documentation at ht
        - name: name
          in: query
          type: string
          required: true
          description: This query parameter specifies the seller-defined name of the return policy you want to retrieve.<br><br>
            This value can be retrieved for a return policy by usi
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sales-tax-countrycode-jurisdictionid
      path: /sales_tax/{countryCode}/{jurisdictionId}
      operations:
      - name: getsalestax
        method: GET
        description: This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction
          to retrieve using the <b>countryCode</b> and <b>jurisdictionId</b> path parameters. All four response fields will
          be returned if
        inputParameters:
        - name: countryCode
          in: path
          type: string
          required: true
          description: This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html
            " title="https://www.iso.org " target="_blank">ISO 3166</a
        - name: jurisdictionId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.<br><br>Valid
            jurisdiction IDs can be retrieved using
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorreplacesalestax
        method: PUT
        description: '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>countryCode</b> and <b>jurisdictionId</b>. <br><br>A tax
          table entry for a jurisd'
        inputParameters:
        - name: countryCode
          in: path
          type: string
          required: true
          description: This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html
            " title="https://www.iso.org " target="_blank">ISO 3166</a
        - name: jurisdictionId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the tax jurisdiction for the table entry to be created.<br><br>Valid
            jurisdiction IDs can be retrieved using the <a href
        - name: Content-Type
          in: header
          type: string
          required: true
          description: This header indicates the format of the request body provided by the client. Its value should be set
            to <b>application/json</b>.<br><br>For more information, re
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletesalestax
        method: DELETE
        description: 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 parameters.<br><br><span class="tablenote"><b>Note:</b> Sales-tax
          tables are only a
        inputParameters:
        - name: countryCode
          in: path
          type: string
          required: true
          description: This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html
            " title="https://www.iso.org " target="_blank">ISO 3166</a
        - name: jurisdictionId
          in: path
          type: string
          required: true
          description: This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.<br><br>Valid
            jurisdiction IDs can be retrieved using th
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sales-tax
      path: /sales_tax
      operations:
      - name: getsalestaxes
        method: GET
        description: 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 jurisdiction that matches the search criteria. <br><br><span
          class="tablenote">
        inputParameters:
        - name: country_code
          in: query
          type: string
          required: true
          description: This path parameter specifies the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html
            " title="https://www.iso.org " target="_blank">ISO 3166</a
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscription
      path: /subscription
      operations:
      - name: getsubscription
        method: GET
        description: This method retrieves a list of subscriptions associated with the seller account.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: This field is for future use.
        - name: continuation_token
          in: query
          type: string
          description: This field is for future use.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: kyc
      path: /kyc
      operations:
      - name: getkyc
        method: GET
        description: <span class="tablenote"><b>Note:</b>This method was originally created to see which onboarding requirements
          were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded
          globally, t
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: advertising-eligibility
      path: /advertising_eligibility
      operations:
      - name: getadvertisingeligibility
        method: GET
        description: This method allows developers to check the seller eligibility status for eBay advertising programs.
        inputParameters:
        - name: program_types
          in: query
          type: string
          description: A comma-separated list of eBay advertising programs for which eligibility status will be returned.<br><br>
            See the <a href="/api-docs/sell/account/types/plser:A
        - name: X-EBAY-C-MARKETPLACE-ID
          in: header
          type: string
          required: true
          description: The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked.
            This header is required or the call will fail.<br><br>Se
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: ebay-rest
    description: REST adapter for eBay Account API.
    resources:
    - path: /custom_policy/
      name: getcustompolicies
      operations:
      - method: GET
  

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ebay/refs/heads/main/capabilities/ebay-capability.yaml