eBay Config API

openapi: 3.2.0
info:
  title: eBay Notification Config API
  description: 'The eBay Notification API enables management of the entire end-to-end eBay notification experience by allowing users to:


    Browse for supported notification topics and retrieve topic details


    Create, configure, and manage notification destination endpoints


    Configure, manage, and test notification subscriptions


    Process eBay notifications and verify the integrity of the message payload'
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://developer.ebay.com/join/api-license-agreement
  version: v1.5.1
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /commerce/notification/v1
tags:
- name: Config
paths:
  /config:
    get:
      tags:
      - Config
      description: This method allows applications to retrieve a previously created configuration.
      operationId: getConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
        '404':
          description: Not Found
          x-response-codes:
            errors:
              '195026':
                domain: API_NOTIFICATION
                category: APPLICATION
                description: Configuration Not Found.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '195000':
                domain: API_NOTIFICATION
                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
      summary: Get config
      x-summary-source: derived
    put:
      tags:
      - Config
      description: This method allows applications to create a new configuration or update an existing configuration. This app-level configuration allows developers to set up alerts.
      operationId: updateConfig
      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: The configurations for this application.
        content:
          application/json:
            schema:
              description: The configurations for this application.
              $ref: '#/components/schemas/Config'
        required: false
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '195025':
                domain: API_NOTIFICATION
                category: REQUEST
                description: Invalid or missing email.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '195000':
                domain: API_NOTIFICATION
                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
      summary: Update config
      x-summary-source: derived
components:
  schemas:
    Config:
      type: object
      properties:
        alertEmail:
          type: string
          description: This field is used to add or modify an email address that will be used for Notification API alerts associated with the application. <b>getConfig</b> can be used to get the email address currently being used for alerts.
      description: The type that defines the fields for the <b>alertEmail</b> field.
  securitySchemes:
    api_auth:
      type: oauth2
      description: The security definitions for this API. Please check individual operations for applicable scopes.
      flows:
        clientCredentials:
          tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
          scopes:
            https://api.ebay.com/oauth/api_scope: View public data from eBay
        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/commerce.notification.subscription.readonly: View your event notification subscriptions
            https://api.ebay.com/oauth/api_scope/commerce.notification.subscription: View and manage your event notification subscriptions