createCustomerServiceMetricTask: eBay Feed API

POST/customer_service_metric_task

Use this method to create a customer service metrics download task with filter criteria for the customer service metrics report. When using this method, specify the feedType and filterCriteria including both evaluationMarketplaceId and customerServiceMetricType for the report. The method returns the location response header containing the call URI to use with getCustomerServiceMetricTask to retrieve status and details on the task.

Only CURRENT Customer Service Metrics reports can be generated with the Sell Feed API. PROJECTED reports are not supported at this time. See the getCustomerServiceMetric method document in the Analytics API for more information about these two types of reports.

Note: Before calling this API, retrieve the summary of the seller's performance and rating for the customer service metric by calling getCustomerServiceMetric (part of the Analytics API). You can then populate the create task request fields with the values from the response. This technique eliminates failed tasks that request a report for a customerServiceMetricType and evaluationMarketplaceId that are without evaluation.

Input

Resource URI

POST https://api.ebay.com/sell/feed/v1/customer_service_metric_task

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header Type Description

Header	Type	Description
Accept-Language	string	Use this header to specify the natural language in which the authenticated user desires the response. For example, `en-US` for English or `de-DE` for German. Occurrence: Required
Content-Type	string	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. Occurrence: Required

Accept-Language

string

Use this header to specify the natural language in which the authenticated user desires the response. For example, en-US for English or de-DE for German.

Occurrence: Required

Content-Type

string

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.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* CreateServiceMetricsTaskRequest */

"feedType" : "string",

"filterCriteria" :

{ /* CustomerServiceMetricsFilterCriteria */

"customerServiceMetricType" : "CustomerServiceMetricTypeEnum : [ITEM_NOT_AS_DESCRIBED,ITEM_NOT_RECEIVED]",

"evaluationMarketplaceId" : "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE...]",

"listingCategories" : [

"string"

"shippingRegions" : [

"ShippingRegionTypeEnum : [DOMESTIC,INTERNATIONAL_MATURED_REGION,INTERNATIONAL_EMERGING_REGION]"

]

"schemaVersion" : "string"

}

Request fields

Input container/field	Type	Description
feedType	string	The feedType specified for the customer service metric task being created. The report lists the transaction details that contribute to the service metrics evaluation. Supported types include: `CUSTOMER_SERVICE_METRICS_REPORT` Occurrence: Required
filterCriteria	CustomerServiceMetricsFilterCriteria	This container is used to customize and set criteria for Customer Service Metric report that will be associated with the task. Occurrence: Required
filterCriteria.customerServiceMetricType	CustomerServiceMetricTypeEnum	An enumeration value that specifies the customer service metric that eBay tracks to measure seller performance. See CustomerServiceMetricTypeEnum for values. Occurrence: Required
filterCriteria.evaluationMarketplaceId	MarketplaceIdEnum	An enumeration value that specifies the eBay marketplace where the evaluation occurs. See MarketplaceIdEnum for values. Occurrence: Required
filterCriteria.listingCategories	array of string	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. Note: Pass this attribute to narrow down your filter results for the `ITEM_NOT_AS_DESCRIBED` customerServiceMetricType. Supported categories include: `primary(L1) category Id` Occurrence: Optional
filterCriteria.shippingRegions	array of ShippingRegionTypeEnum	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. Note: Pass this attribute to narrow down your filter results for the `ITEM_NOT_RECEIVED` customerServiceMetricType. Supported categories include: `primary(L1) category Id` See ShippingRegionTypeEnum for values Occurrence: Optional
schemaVersion	string	The version number of the customer service metric. Note: This field must have a value of `1.0`. Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The location response header contains the getCustomerServiceMetricTask call URI that you can use to retrieve the customer service metric task just created.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
202	Accepted
400	Bad Request
403	Forbidden
500	Internal Server Error

Error codes

Note: Error Code 160001 may indicate a rate limit error (same as 160024 or 160025). For additional information, see Feed limits.

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
160001	API_FEED	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160017	API_FEED	REQUEST	The 'feedType' is missing or invalid.
160018	API_FEED	REQUEST	The 'schemaVersion' is invalid.
160024	API_FEED	REQUEST	You have reached the maximum number of feed tasks that can be queued or processed concurrently. Wait for current tasks to complete before adding tasks. For more information, see the documentation for this API.
160025	API_FEED	REQUEST	You have exceeded the maximum number of feed tasks that can be created or processed in a given period (hour or day). Wait until the present period ends before adding tasks. For more information, see the documentation for this API.
164500	API_FEED	REQUEST	The 'customerServiceMetricType' in 'filterCriteria' is not a valid type. Valid metric types are ITEM_NOT_AS_DESCRIBED or ITEM_NOT_RECEIVED.
164501	API_FEED	REQUEST	The 'evaluationMarketplaceId' in 'filterCriteria' is not a supported marketplace. For a complete list of the supported marketplace IDs, see the documentation.
164502	API_FEED	REQUEST	The 'listingCategories' in 'filterCriteria' or some part of the 'listingCategories' is invalid. {additionalInfo}
164503	API_FEED	REQUEST	The 'shippingRegions' in 'filterCriteria' or some part of the 'shippingRegions' is invalid. {additionalInfo}
164504	API_FEED	REQUEST	The Accept-Language header is missing or invalid.
164505	API_FEED	REQUEST	The 'filterCriteria' is missing or invalid.
164506	API_FEED	REQUEST	The 'listingCategories' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'.
164507	API_FEED	REQUEST	The 'shippingRegions' is not applicable to the 'customerServiceMetricType' {customerServiceMetricType} in 'filterCriteria'.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Create an Item Not Received Customer Service Metrics Download Task

Sample 2: Create an Item Not As Described Customer Service Metrics Download Task

Sample 1: Create an Item Not Received Customer Service Metrics Download Task

This call creates a task that retrieves an Item Not Received customer service metrics report for the specified feedType and filterCriteria.

Input

The inputs are feedType, filterCriteria (including shippingRegions, evaluationMarketplaceId, and customerServiceMetricType), and schemaVersion.

POSThttps://api.ebay.com/sell/feed/v1/customer_service_metric_task

Output

The output is an HTTP status. If the call is successful, the task ID is returned in the Location response header.

Sample 2: Create an Item Not As Described Customer Service Metrics Download Task

This call creates a task that retrieves an Item Not As Described customer service metrics report for the specified feedType and filterCriteria.

Input

The inputs are feedType, filterCriteria (including listingCategories, evaluationMarketplaceId, and customerServiceMetricType), and schemaVersion.

POSThttps://api.ebay.com/sell/feed/v1/customer_service_metric_task

Output

The output is an HTTP status. If the call is successful, the task ID is returned in the Location response header. This method has no response payload.