Skip to main content

DELETE/ad_report_task/{report_task_id}

This call deletes the report task specified by the report_task_id path parameter. This method also deletes any reports generated by the report task.

Report task IDs are generated by eBay when you call createReportTask. Get a complete list of a seller's report-task IDs by calling getReportTasks.


Important!For ad_report and ad_report_task methods, the API call limit is subject to a per user quota. These API calls can only be executed a maximum of 200 times per hour for each seller/user. If the number of calls per hour exceeds this limit, any new calls will be blocked for the next hour.

Input

Resource URI

DELETE https://api.ebay.com/sell/marketing/v1/ad_report_task/{report_task_id}

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

ParameterTypeDescription
report_task_idstringThis path parameter specifies the unique identifier of the report task being deleted.

Use the getReportTasks method to retrieve report task Ids.

Occurrence: Required

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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.marketing

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

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.

StatusMeaning
204No Content
404Not found
409Conflict
500Internal Server error

Error codes

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

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35140API_MARKETINGREQUESTNo ReportTask found for 'report_task_id' {report_task_id}. Please correct the 'report_task_id' and try again.
35141API_MARKETINGBUSINESSThe Report Task with 'report_task_id' {report_task_id} is being modified. Please wait a few minutes and try the call again.

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: Delete Report Task

This sample deletes the specified report task.

Input

Specify the report task you want to delete using the report_task_id URI parameter. The ID for a report task is returned in the Location HTTP response header of the createReportTask call you used to create the task.

DELETEhttps://api.ebay.com/sell/marketing/v1/ad_report_task/1********4

Output

A successful call returns the HTTP status code 204 No content. This method has no response payload.