openapi: 3.0.0
info:
title: eBay Account Advertising_eligibility Seller_standards_profile 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: Seller_standards_profile
paths:
/seller_standards_profile:
get:
tags:
- Seller_standards_profile
description: This call retrieves all the standards profiles for the associated seller. <br><br>A <i>standards profile </i> is a set of eBay seller metrics and the seller's associated compliance values (either <code>TOP_RATED</code>, <code>ABOVE_STANDARD</code>, or <code>BELOW_STANDARD</code>). <br><br>A seller's multiple profiles are distinguished by two criteria, a "program" and a "cycle." A profile's <i>program </i> is one of three regions where the seller may have done business, or <code>PROGRAM_GLOBAL</code> to indicate all marketplaces where the seller has done business. The <i>cycle</i> value specifies whether the standards compliance values were determined at the last official eBay evaluation or at the time of the request.
operationId: findSellerStandardsProfiles
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/FindSellerStandardsProfilesResponse'
'400':
description: Bad Request
'500':
description: Internal Server Error
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
/seller_standards_profile/{program}/{cycle}:
get:
tags:
- Seller_standards_profile
description: This call retrieves a single standards profile for the associated seller. <br><br>A <i>standards profile </i> is a set of eBay seller metrics and the seller's associated compliance values (either <code>TOP_RATED</code>, <code>ABOVE_STANDARD</code>, or <code>BELOW_STANDARD</code>). <br><br>A seller can have multiple profiles distinguished by two criteria, a "program" and a "cycle." A profile's <i>program </i> is one of three regions where the seller may have done business, or <code>PROGRAM_GLOBAL</code> to indicate all marketplaces where the seller has done business. The <i>cycle</i> value specifies whether the standards compliance values were determined at the last official eBay evaluation (<code>CURRENT</code>) or at the time of the request (<code>PROJECTED</code>). Both cycle and a program values are required URI parameters for this method.
operationId: getSellerStandardsProfile
parameters:
- name: cycle
in: path
description: This path parameter is used to specify the cycle for which metrics and metadata will be retrieved.<br><br>See <a href="/api-docs/sell/analytics/types/ssp:CycleTypeEnum" target="_blank">CycleTypeEnum</a> for a list of supported values.
required: true
schema:
type: string
- name: program
in: path
description: This path parameter is used to specify the seller standards program for which metrics and metadata will be retrieved. <br><br>See <a href="/api-docs/sell/analytics/types/ssp:ProgramEnum" target="_blank">ProgramEnum</a> for a list of supported values.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StandardsProfile'
'204':
description: No content
'400':
description: Bad Request
x-response-codes:
errors:
'53100':
domain: API_ANALYTICS
category: REQUEST
description: Program Id cannot be empty.
'53105':
domain: API_ANALYTICS
category: REQUEST
description: Invalid program Id {programId}
'53110':
domain: API_ANALYTICS
category: REQUEST
description: Cycle Id cannot be empty.
'53115':
domain: API_ANALYTICS
category: REQUEST
description: Invalid cycle Id {cycleId}
'404':
description: Resource not found
'500':
description: Internal Server Error
x-response-codes:
errors:
'53120':
domain: API_ANALYTICS
category: APPLICATION
description: Internal server error. Wait a few minutes and try the call again. If error persists contact the eBay Developer Program.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
components:
schemas:
Metric:
type: object
properties:
benchmark:
description: This complex type defines a set of benchmark data, which includes the <b>average</b> rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark. <br><br>This container is returned only if the associated <b>metricKey</b> value is <code>RATE</code>.
$ref: '#/components/schemas/MetricBenchmark'
distributions:
type: array
description: Returned when <b>metricKey</b> equals <code>COUNT</code>, this field returns an array of seller data where each set of data is grouped according by an overarching <b>basis</b>. <br><br>When the seller distribution is returned, the numeric value of the associated <b>value</b> container equals the sum of the transactions where the seller meets the criteria of the customer service metric type for the given <b>dimension</b> during the <b>evaluationCycle</b>.
items:
$ref: '#/components/schemas/MetricDistribution'
metricKey:
type: string
description: 'This field indicates the customer service metric being returned in the associated <b>metrics</b> container. The field is set as follows: <ul><li><code>TRANSACTION_COUNT</code> – When set to this value, the associated <b>value</b> field returns the number of transactions completed in the peer group for the metric being evaluated in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li> <li><code>COUNT</code> – When set to this value, the associated <b>value</b> field is set to the number of transactions completed by the seller for the metric being evaluated in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li> <li><code>RATE</code> – When set to this value, the fields in the associated container return the seller''s calculated <b>value</b> for the associated customer service metric along with the benchmark data against which the seller is evaluated. <br><br>Specifically, when <b>metricKey</b> is set to <code>RATE</code>, the associated <b>value</b> field is set to the value of <b>metricKey</b> <code>TRANSACTION_COUNT</code> divided by the value of <b>metricKey</b> <code>COUNT</code>. <br><br>The <b>benchmark.rating</b> value is the seller''s rating for the metric in the associated <b>dimension</b> and <b>evaluationCycle</b>.</li></ul>'
value:
type: string
description: This field is set to the seller's numeric rating for the associated <b>metricKey</b> for the given <b>dimension</b> during the <b>evaluationCycle</b>. <br><br>To determine the seller's rating for this metric, the value of this field is compared to the average metric value of the group.
description: This complex data type defines the details of the customer service metric and benchmark data related to the associated <b>dimension</b>.
BenchmarkMetadata:
type: object
properties:
average:
type: string
description: This field returns the average value for the group, as defined by the specified <b>basis</b>. <br><br>When the benchmark <b>basis</b> is set to <code>PEER_BENCHMARK</code>, the value returned in this field is the benchmark value to which the seller's metric <b>value</b> is compared to determine the seller's rating for the customer service metric.
description: This complex type defines the fields that comprise the benchmark against which the seller's performance is compared. The comparison determines the seller's rating for the metric.
MetricBenchmark:
type: object
properties:
adjustment:
type: string
description: If this field is present, it indicates that the rating given to the seller was "adjusted" for one reason or another. <br><br>If eBay determines that the normal rating of a seller is impacted by circumstances beyond their control, they can issue an override to adjust the rating given to the seller. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/api:RatingAdjustmentTypeEnum'>eBay API documentation</a>
basis:
type: string
description: This field returns the "basis" by which the benchmark is calculated for the customer service metric type. <br><br>Currently, the only supported basis is <code>PEER_BENCHMARK</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/api:BenchmarkTypeEnum'>eBay API documentation</a>
metadata:
description: This field contains the benchmark data.
$ref: '#/components/schemas/BenchmarkMetadata'
rating:
type: string
description: This field returns seller's rating for the customer service metric. <br><br>The rating is set to a value that equals the relative deviation between the seller's metric value and the benchmark value for the customer service metric. <br><br>Deviation values range from <code>LOW</code> to <code>VERY HIGH</code>, and the lower the deviation, the better the seller rating. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/api:RatingTypeEnum'>eBay API documentation</a>
description: This complex type defines the benchmark data, which includes the <b>average</b> value of the metric for the group (the benchmark) and the seller's overall <b>rating</b> when compared to the benchmark.
StandardsProfile:
type: object
properties:
cycle:
description: A complex type that specifies the profile's evaluation cycle (<code>CURRENT</code> or <code>PROJECTED</code>), the date the evaluation was calculated, and the month to which the evaluation pertains. <br><br>Each program has at least one cycle, but a program can include both cycle types.
$ref: '#/components/schemas/Cycle'
defaultProgram:
type: boolean
description: If set to <code>true</code>, this flag indicates this is the default program for the seller. <br><br>Except for sellers in China, a seller's default program is the marketplace where they registered with eBay. Seller's in China select their default program when they register.
evaluationReason:
type: string
description: Specifies how the overall seller level was calculated. <br><br>In the event of special circumstances (as determined by eBay), eBay may override the calculated seller level. In general, such overrides protect a seller's level. The usual value for both cycle types is "Seller level generated by standards monthly evaluation cycle."
metrics:
type: array
description: A list of the metrics upon which a seller's profile is evaluated. <br><br>Each program's applicable metrics and requirements are listed at <a href="http://www.sps.ebay.com/sd/sdrequirements" target="_blank">eBay Top Rated seller program standards</a>.
items:
$ref: '#/components/schemas/Metric'
program:
type: string
description: Indicates the program used to generate the profile data. Values can be <code>PROGRAM_DE</code>, <code>PROGRAM_UK</code>, <code>PROGRAM_US</code>, or <code>PROGRAM_GLOBAL</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:ProgramEnum'>eBay API documentation</a>
standardsLevel:
type: string
description: The overall standards level of the seller, one of <code>TOP_RATED</code>, <code>ABOVE_STANDARD</code>, or <code>BELOW_STANDARD</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:StandardsLevelEnum'>eBay API documentation</a>
description: A complex type that defines a seller profile.
Distribution:
type: object
properties:
name:
type: string
description: The name of a distribution in which the seller is active.
value:
type: string
description: This field contains the number of transactions the seller had in the distribution (identified by the associated <b>name</b> field) during the metric <b>evaluationCycle</b>.
description: This complex type defines of a piece of data that is grouped by the associated <b>basis</b>. It contains the <b>name</b> for the data set and its associated <b>value</b>.
MetricDistribution:
type: object
properties:
basis:
type: string
description: This field returns the basis, or the method, by which the metric rating is calculated.
data:
type: array
description: This field returns a list of name/value pairs, where the <b>name</b> indicates the distribution being rated and the <b>value</b> indicates the count of seller transactions that meet the distribution criteria.
items:
$ref: '#/components/schemas/Distribution'
description: This complex data type describes the metric distribution by basis.
FindSellerStandardsProfilesResponse:
type: object
properties:
standardsProfiles:
type: array
description: A list of the seller's standards profiles. <br><br>A "standards profile" is a set of eBay seller standards categories and the values related to the associated seller. <br><br>Profiles are distinguished by a combination of cycle and program values. The "program" value specifies the region to which the data is from. The "cycle" value specifies whether the values were determined just now, or if the values are from the last official eBay seller standards evaluation.
items:
$ref: '#/components/schemas/StandardsProfile'
description: The response container for a list of seller profiles.
Cycle:
type: object
properties:
cycleType:
type: string
description: The cycle type, either <code>CURRENT</code> or <code>PROJECTED</code>. <br><br><code>CURRENT</code> means the profile's metrics values are from the most recent official eBay monthly standards evaluation. <code>PROJECTED</code> means the profile values were determined when the profile was requested. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/analytics/types/ssp:CycleTypeEnum'>eBay API documentation</a>
evaluationDate:
type: string
description: The date and time at which the standard compliance values were determined for the profile. <br><br>The time stamp is formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2018-08-04T07:09:00.000Z</code>
evaluationMonth:
type: string
description: The month in which the currently effective seller level was computed. <br><br>The value is always formatted as <code>YYYY-MM</code>. If the cycle is <code>CURRENT</code>, this value is the month and year the of the last eBay compliance evaluation. If this is for a <code>PROJECTED</code> cycle, the value is the month and year of the next scheduled evaluation. Because eBay does official evaluations around the 20th of each month, a <code>PROJECTED</code> value may indicate either the current or the next month.
description: A complex type that describes a program cycle.
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