eBay User API

openapi: 3.0.0
info:
  title: eBay Account Advertising_eligibility User 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>.
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://go.developer.ebay.com/api-license-agreement
  version: v1.9.2
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /sell/account/v1
tags:
- name: User
paths:
  /user/:
    get:
      tags:
      - User
      description: 'This method retrieves the account profile information for an authenticated user, which requires a <a href="/api-docs/static/oauth-authorization-code-grant.html">User access token</a>. What is returned is controlled by the <a href="#scopes">scopes</a>. <p>For a business account you use the default scope <code>commerce.identity.readonly</code>, which returns all the fields in the <a href="/api-docs/commerce/identity/resources/user/methods/getUser#response.businessAccount">businessAccount</a> container. These are returned  because this is all public information.</p>  <p> For an individual account, the fields returned in the <a href="/api-docs/commerce/identity/resources/user/methods/getUser#response.individualAccount">individualAccount</a> container are based on the scope you use. Using the default scope, only public information, such as eBay user ID, are returned. For details about what each scope returns, see the <a href="/api-docs/commerce/identity/overview.html">Identity API Overview</a>.</p> <p>In the Sandbox, this API returns mock data. <b>Note: </b> You must use the correct scope or scopes for the data you want returned.</p>'
      operationId: getUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
        '404':
          description: Not found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '140000':
                domain: API_IDENTITY
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/commerce.identity.readonly
        - https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly
        - https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly
        - https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly
        - https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly
components:
  schemas:
    Address:
      type: object
      properties:
        addressLine1:
          type: string
          description: The first line of the street address.
        addressLine2:
          type: string
          description: The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.
        city:
          type: string
          description: The city of the address.
        country:
          type: string
          description: The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> standard of the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/bas:CountryCodeEnum'>eBay API documentation</a>
        county:
          type: string
          description: The county of the address.
        postalCode:
          type: string
          description: The postal code of the address.
        stateOrProvince:
          type: string
          description: The state or province of the address.
      description: The type that defines the fields for an address.
    Contact:
      type: object
      properties:
        firstName:
          type: string
          description: The first name of the contact person.
        lastName:
          type: string
          description: The last name of the contact person.
      description: The type that defines the fields for the information of the contact person for the account.
    UserResponse:
      type: object
      properties:
        accountType:
          type: string
          description: 'Indicates the user account type. This is determined when the user registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following countries:   <br /><br />EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL <br /><br /><b> Valid Values:</b> BUSINESS or INDIVIDUAL <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/commerce/identity/types/api:AccountTypeEnum''>eBay API documentation</a>'
        businessAccount:
          description: The container that returns the business account information of the user.
          $ref: '#/components/schemas/BusinessAccount'
        individualAccount:
          description: The account information of the user.
          $ref: '#/components/schemas/IndividualAccount'
        registrationMarketplaceId:
          type: string
          description: The eBay site on which the account is registered. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/bas:MarketplaceIdEnum'>eBay API documentation</a>
        status:
          type: string
          description: 'Indicates the user''s account status. Possible values: <code>CONFIRMED</code>, <code>UNCONFIRMED</code>, <code>ACCOUNTONHOLD</code> and <code>UNDETERMINED</code>. For implementation help, refer to <a href=''https://developer.ebay.com/api-docs/commerce/identity/types/api:UserStatusEnum''>eBay API documentation</a>'
        userId:
          type: string
          description: The eBay immutable user ID of the user's account and can always be used to identify the user.
        username:
          type: string
          description: 'The user name, which was specific by the user when they created the account. <br /><br /><span class="tablenote"><b>Note: </b> This value can be changed by the user.</span>'
      description: The type that defines the fields for the <b>getUser</b> method.
    Phone:
      type: object
      properties:
        countryCode:
          type: string
          description: The two-letter <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> standard of the country to which the phone number belongs.
        number:
          type: string
          description: The numeric string representing the phone number.
        phoneType:
          type: string
          description: 'The type of phone service. <br /><br /><b> Valid Values: </b> MOBILE or LAND_LINE  <br /><br />Code so that your app gracefully handles any future changes to this list.'
      description: The type that defines the fields for the details of a phone.
    BusinessAccount:
      type: object
      properties:
        address:
          description: 'The container that returns the address of the business account. '
          $ref: '#/components/schemas/Address'
        doingBusinessAs:
          type: string
          description: An additional name that is used for their business on eBay. The business name is returned in the <b> name</b> field.
        email:
          type: string
          description: The email address of the business account.
        name:
          type: string
          description: The business name associated with the user's eBay account.
        primaryContact:
          description: The container that returns the contact details of the person who is the primary contact for this account.
          $ref: '#/components/schemas/Contact'
        primaryPhone:
          description: The container that returns the primary phone number for the business account.
          $ref: '#/components/schemas/Phone'
        secondaryPhone:
          description: The container that returns the secondary phone number for the business account.
          $ref: '#/components/schemas/Phone'
        website:
          type: string
          description: The business website address associated with the eBay account.
      description: The type that defines the fields for the business account information.
    IndividualAccount:
      type: object
      properties:
        email:
          type: string
          description: The eBay user's registration email address.
        firstName:
          type: string
          description: The eBay user's first name.
        lastName:
          type: string
          description: The eBay user's last name.
        primaryPhone:
          description: The container that returns the eBay user's primary phone number information.
          $ref: '#/components/schemas/Phone'
        registrationAddress:
          description: The container that returns the eBay user's address information.
          $ref: '#/components/schemas/Address'
        secondaryPhone:
          description: The container that returns the eBay user's secondary phone number information.
          $ref: '#/components/schemas/Phone'
      description: The type that defines the fields for the information of an individual account.
  securitySchemes:
    api_auth:
      type: oauth2
      description: The security definitions for this API. Please check individual operations for applicable scopes.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.ebay.com/oauth2/authorize
          tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
          scopes:
            https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings
            https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings