eBay · Schema

CustomerServiceMetricsFilterCriteria

A complex data type that filters data for report creation. See CustomerServiceMetricsFilterCriteria for fields and descriptions.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
customerServiceMetricType string An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance.

See Custome
evaluationMarketplaceId string An enumeration value that specifies the eBay marketplace where the evaluation occurs.

See MarketplaceIdEnum for values. For impleme
listingCategories array A list of listing category IDs on which the service metric is measured. A seller can use one or more L1 (top-level) eBay categories to get metrics specific to those L1 categories. The Category IDs for
shippingRegions array A list of shipping region enumeration values on which the service metric is measured. This comma delimited array allows the seller to customize the report to focus on domestic or international shippin
View JSON Schema on GitHub

JSON Schema

ebay-customerservicemetricsfiltercriteria-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerServiceMetricsFilterCriteria",
  "title": "CustomerServiceMetricsFilterCriteria",
  "type": "object",
  "properties": {
    "customerServiceMetricType": {
      "type": "string",
      "description": "An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance.<br><br>See <a href=\"/api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum\">CustomerServiceMetricTypeEnum</a> for values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:CustomerServiceMetricTypeEnum'>eBay API documentation</a>"
    },
    "evaluationMarketplaceId": {
      "type": "string",
      "description": "An enumeration value that specifies the eBay marketplace where the evaluation occurs.<br><br>See <a href=\"/api-docs/sell/feed/types/bas:MarketplaceIdEnum\">MarketplaceIdEnum</a> for values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/bas:MarketplaceIdEnum'>eBay API documentation</a>"
    },
    "listingCategories": {
      "type": "array",
      "description": "A list of listing category IDs on which the service metric is measured. A seller can use one or more L1 (top-level) eBay categories to get metrics specific to those L1 categories. The Category IDs for each L1 category are required. Category ID values for L1 categories can be retrieved using the Taxonomy API.<p> <span class=\"tablenote\"><strong>Note: </strong>Pass this attribute to narrow down your filter results for the <code>ITEM_NOT_AS_DESCRIBED</code> customerServiceMetricType.</span></p> <p>Supported categories include:</p><p><code>primary(L1) category Id</code></p>",
      "items": {
        "type": "string"
      }
    },
    "shippingRegions": {
      "type": "array",
      "description": "A list of shipping region enumeration values on which the service metric is measured. This comma delimited array allows the seller to customize the report to focus on domestic or international shipping. <p> <span class=\"tablenote\"><strong>Note: </strong>Pass this attribute to narrow down your filter results for the <code>ITEM_NOT_RECEIVED</code> customerServiceMetricType.</span></p> <p>Supported categories include:</p><p><code>primary(L1) category Id</code></p>See <strong>ShippingRegionTypeEnum</strong> for values",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/feed/types/api:ShippingRegionTypeEnum'>eBay API documentation</a>"
      }
    }
  },
  "description": "A complex data type that filters data for report creation. See <strong>CustomerServiceMetricsFilterCriteria</strong> for fields and descriptions."
}