eBay

eBay Program API

The Program API from eBay — 3 operation(s) for program.

Documentation GitHub OpenAPI

Operations 3

GET /program/get_opted_in_programs Get opted in programs #

POST /program/opt_in Opt in to program #

POST /program/opt_out Opt out of program #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ebay-program-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: eBay Account Program API
  description: '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.'
  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
      summary: Get opted in programs
      x-summary-source: derived
  /program/opt_in:
    post:
      tags:
      - Program
      description: 'This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs.


        Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.'
      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
      summary: Opt in to program
      x-summary-source: derived
  /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 getOptedInPrograms 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
      summary: Opt out of program
      x-summary-source: derived
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