openapi: 3.0.0
info:
title: eBay Account Advertising_eligibility Config 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: 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
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 application/json.
For more information, refer to HTTP request headers.
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
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. getConfig can be used to get the email address currently being used for alerts.
description: The type that defines the fields for the alertEmail field.
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