openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Seller_standards_profile 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: Seller_standards_profile paths: /seller_standards_profile: get: tags: - Seller_standards_profile description: This call retrieves all the standards profiles for the associated seller.

A standards profile is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).

A seller's multiple profiles are distinguished by two criteria, a "program" and a "cycle." A profile's program is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle 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.

A standards profile is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).

A seller can have multiple profiles distinguished by two criteria, a "program" and a "cycle." A profile's program is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation (CURRENT) or at the time of the request (PROJECTED). 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.

See CycleTypeEnum 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.

See ProgramEnum 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 average rating for the group included in the benchmark evaluation and the seller's calculated customer service metric rating for the benchmark.

This container is returned only if the associated metricKey value is RATE. $ref: '#/components/schemas/MetricBenchmark' distributions: type: array description: Returned when metricKey equals COUNT, this field returns an array of seller data where each set of data is grouped according by an overarching basis.

When the seller distribution is returned, the numeric value of the associated value container equals the sum of the transactions where the seller meets the criteria of the customer service metric type for the given dimension during the evaluationCycle. items: $ref: '#/components/schemas/MetricDistribution' metricKey: type: string description: 'This field indicates the customer service metric being returned in the associated metrics container. The field is set as follows: ' value: type: string description: This field is set to the seller's numeric rating for the associated metricKey for the given dimension during the evaluationCycle.

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 dimension. BenchmarkMetadata: type: object properties: average: type: string description: This field returns the average value for the group, as defined by the specified basis.

When the benchmark basis is set to PEER_BENCHMARK, the value returned in this field is the benchmark value to which the seller's metric value 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.

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 eBay API documentation basis: type: string description: This field returns the "basis" by which the benchmark is calculated for the customer service metric type.

Currently, the only supported basis is PEER_BENCHMARK. For implementation help, refer to eBay API documentation 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.

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.

Deviation values range from LOW to VERY HIGH, and the lower the deviation, the better the seller rating. For implementation help, refer to eBay API documentation description: This complex type defines the benchmark data, which includes the average value of the metric for the group (the benchmark) and the seller's overall rating when compared to the benchmark. StandardsProfile: type: object properties: cycle: description: A complex type that specifies the profile's evaluation cycle (CURRENT or PROJECTED), the date the evaluation was calculated, and the month to which the evaluation pertains.

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 true, this flag indicates this is the default program for the seller.

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.

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.

Each program's applicable metrics and requirements are listed at eBay Top Rated seller program standards. items: $ref: '#/components/schemas/Metric' program: type: string description: Indicates the program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL. For implementation help, refer to eBay API documentation standardsLevel: type: string description: The overall standards level of the seller, one of TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD. For implementation help, refer to eBay API documentation 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 name field) during the metric evaluationCycle. description: This complex type defines of a piece of data that is grouped by the associated basis. It contains the name for the data set and its associated value. 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 name indicates the distribution being rated and the value 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.

A "standards profile" is a set of eBay seller standards categories and the values related to the associated seller.

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 CURRENT or PROJECTED.

CURRENT means the profile's metrics values are from the most recent official eBay monthly standards evaluation. PROJECTED means the profile values were determined when the profile was requested. For implementation help, refer to eBay API documentation evaluationDate: type: string description: The date and time at which the standard compliance values were determined for the profile.

The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-04T07:09:00.000Z evaluationMonth: type: string description: The month in which the currently effective seller level was computed.

The value is always formatted as YYYY-MM. If the cycle is CURRENT, this value is the month and year the of the last eBay compliance evaluation. If this is for a PROJECTED 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 PROJECTED 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