Deletes the recurring job. If you only want to delete a single instance of the recurring job, use abortRecurringJob. If you only want to stop the recurring job, but plan to start it again later, use suspendRecurringJob.
Output Samples Change History |
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <deleteRecurringJobRequest xmlns="http://www.ebay.com/marketplace/services"> <!-- Call-specific Input Fields --> <recurringJobId> string </recurringJobId> </deleteRecurringJobRequest>
Argument | Type | Occurrence | Meaning |
---|
recurringJobId | string | Required | Unique ID assigned by the Bulk Data Exchange API for managing your recurring job. Use the recurringJobId value returned in the createRecurringJob response. You can also use getRecurringJobs to retrieve recurringJobId values for any recurring jobs you have created. |
Input Samples Change History |
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also Samples.
<?xml version="1.0" encoding="utf-8"?> <deleteRecurringJobResponse xmlns="http://www.ebay.com/marketplace/services"> <!-- (No call-specific Output fields) --> <!-- Standard Output Fields --> <ack> AckValue </ack> <errorMessage> ErrorMessage <error> ErrorData <category> ErrorCategory </category> <domain> string </domain> <errorId> long </errorId> <exceptionId> token </exceptionId> <message> string </message> <parameter name="string"> ErrorParameter (string) </parameter> <!-- ... more parameter nodes allowed here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes allowed here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> </deleteRecurringJobResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
Standard Output Fields |
ack | AckValue | Always |
Returns the acknowledgement of the call success or failure.
Applicable values: |
errorMessage | ErrorMessage | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. |
errorMessage.error | ErrorData | Conditionally,
repeatable: [0..*] |
Details about a single error. |
errorMessage.error.category | ErrorCategory | Conditionally |
There are three categories of errors: request errors, application errors, and system errors.
Applicable values: |
errorMessage.error.domain | string | Conditionally |
Name of the domain upon which the error occurred.
|
errorMessage.error.errorId | long | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. |
errorMessage.error.exceptionId | token | Conditionally | Unique identifier for an exception associated with an error. |
errorMessage.error.message | string | Conditionally | A detailed description of the condition that resulted in the error. |
errorMessage.error.parameter | ErrorParameter (string) | Conditionally,
repeatable: [0..*] |
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.parameter [ attribute name ] |
string | Conditionally | Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.severity | ErrorSeverity | Conditionally |
Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: |
errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain upon which the error occurred.
|
timestamp | dateTime | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. |
version | string | Always |
The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. |
Input Output Change History |
New to making API calls? Please see Making an API Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Deletes a recurring job for the Bulk Data Exchange service. Once deleted, you can not resume processing on this job.
Description
User megaonlinemerchant
wants to stop the weekly processing of the ActiveInventoryReport that she has set up as a recurring job.
As a result of this call, megaonlinemerchant
will no longer download the ActiveInventoryReport each week.
Input
In the following deleteRecurringJob request sample, you will see that you only need to provide the recurringJobId.
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <deleteRecurringJobRequest xmlns="http://www.ebay.com/marketplace/services"> <recurringJobId>5000000701</recurringJobId> </deleteRecurringJobRequest>
Output
The response includes a Success or Failure acknowledgement, a timestamp, and the version number of the Bulk Data Exchange service.
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <deleteRecurringJobResponse xmlns="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2008-11-05T03:52:44.558Z</timestamp> </deleteRecurringJobResponse>
Input Output Samples |
Change Date | Description |
---|---|
1.0.0 2008-11-29 |
|
Copyright © 2013–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.