eBay Program API

openapi: 3.0.0
info:
  title: eBay Account Advertising_eligibility Program 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: Program
paths:
  /program/get_opted_in_programs:
    get:
      tags:
      - Program
      description: This method gets a list of the seller programs that the seller has opted-in to.
      operationId: getOptedInPrograms
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Programs'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20404':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} not found.'
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
              '20501':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Service unavailable. Please try again in next 24 hours.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.account
        - https://api.ebay.com/oauth/api_scope/sell.account.readonly
  /program/opt_in:
    post:
      tags:
      - Program
      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="tablenote"><b>Note:</b> It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the <a href="/api-docs/sell/account/resources/program/methods/getOptedInPrograms" target="_blank">getOptedInPrograms</a> call to check the status of your request after the processing period has passed.</span>
      operationId: optInToProgram
      parameters:
      - name: Content-Type
        in: header
        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, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
        required: true
        schema:
          type: string
      requestBody:
        description: Program being opted-in to.
        content:
          application/json:
            schema:
              description: Program being opted-in to.
              $ref: '#/components/schemas/Program'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20401':
                domain: API_ACCOUNT
                category: REQUEST
                description: Missing field {fieldName}. {additionalInfo}
        '404':
          description: Not Found
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '25803':
                domain: API_ACCOUNT
                category: BUSINESS
                description: '{fieldName} already exists.'
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
              '20501':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Service unavailable. Please try again in next 24 hours.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.account
  /program/opt_out:
    post:
      tags:
      - Program
      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.
      operationId: optOutOfProgram
      parameters:
      - name: Content-Type
        in: header
        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, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
        required: true
        schema:
          type: string
      requestBody:
        description: Program being opted-out of.
        content:
          application/json:
            schema:
              description: Program being opted-out of.
              $ref: '#/components/schemas/Program'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20401':
                domain: API_ACCOUNT
                category: REQUEST
                description: Missing field {fieldName}. {additionalInfo}
              '25804':
                domain: API_ACCOUNT
                category: REQUEST
                description: '{fieldName} already exists'
        '404':
          description: Not Found
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: System error.
              '20501':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Service unavailable. Please try again in next 24 hours.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.account
components:
  schemas:
    Program:
      type: object
      properties:
        programType:
          type: string
          description: A seller program in to which a seller can opt-in. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum'>eBay API documentation</a>
      description: A seller program in to which a seller can opt-in.
    Programs:
      type: object
      properties:
        programs:
          type: array
          description: An array of seller programs that the seller's account is opted in to.
          items:
            $ref: '#/components/schemas/Program'
      description: The base response type of the <b>getOptedInPrograms</b> method.
  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