getRecurringJobs

Get all recurring jobs submitted by this seller. There should only be one recurring job per job type.



Back to top

Input Output Samples Change History User Notes
getRecurringJobs Input

getRecurringJobs has no input fields.



Back to top

Input Output Samples Change History User Notes
getRecurringJobs Output

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"?>
<getRecurringJobsResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- 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 here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <recurringJobDetail> RecurringJobDetail
    <creationTime> dateTime </creationTime>
    <dailyRecurrence> DailyRecurrence
      <timeOfDay> time </timeOfDay>
    </dailyRecurrence>
    <downloadJobType> token </downloadJobType>
    <frequencyInMinutes> int </frequencyInMinutes>
    <jobStatus> RecurringJobStatus </jobStatus>
    <monthlyRecurrence> MonthlyRecurrence
      <dayOfMonth> token </dayOfMonth>
      <timeOfDay> time </timeOfDay>
    </monthlyRecurrence>
    <recurringJobId> string </recurringJobId>
    <weeklyRecurrence> WeeklyRecurrence
      <dayOfWeek> token </dayOfWeek>
      <timeOfDay> time </timeOfDay>
    </weeklyRecurrence>
  </recurringJobDetail>
  <!-- ... more recurringJobDetail nodes here ... -->
</getRecurringJobsResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
ack AckValue Always Returns the acknowledgement of the call success or failure.

Applicable values:

•   Failure

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

•   PartialFailure

(out) Reserved for future use.

•   Success

(out) The request was processed successfully, but something occurred that may affect your application or the user.

•   Warning

(out) The request that triggered the error was processed successfully but with some warnings.
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:

•   Application

(out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the application or data is resolved, resend the corrected request to eBay.

•   Request

(out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data.

•   System

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application 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.
errorMessage.error.domain string Conditionally Name of the domain upon which the error occurred.
Domains include:
Marketplace
A business or validation error occurred for the Bulk Data Exchange service.
SOA
An exception occurred in the Service Oriented Architecture (SOA) framework.
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 The name of the parameter in the get of parameter types returned within the error type.
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:

•   Error

(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

•   Warning

(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain string Conditionally Name of the subdomain upon which the error occurred.
Subdomains include:
BulkDataExchangeService
The error is specific to the BulkDataExchangeService service.
MarketplaceCommon
The error is common to all Marketplace services.
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.
Call-specific Output Fields
recurringJobDetail RecurringJobDetail Always,
repeatable: [1..*]		 Recurring job ID, creation time, frequency, job type, and job status for a recurring job.
recurringJobDetail
  .creationTime 		dateTime Always The date and time a Bulk Data Exchange job was created.
recurringJobDetail
  .dailyRecurrence 		DailyRecurrence Conditionally Optional element to define the recurrence interval for daily jobs.
recurringJobDetail
  .dailyRecurrence.timeOfDay 		time Conditionally Recurring Time for the job to run ex:08:00:00.000Z
recurringJobDetail
  .downloadJobType 		token Always Specifies the report you want to download. Each Bulk Data Exchange job can only have one job type per job. For instance, if you are downloading a SoldReport, it will only have pre-defined SoldReport data within the file.

Applicable values:
ActiveInventoryReport
A report that contains all of the active listings for a specific seller ID. The eBay servers read the credential information passed in by the seller's application to determine which seller's data to retrieve.
FeeSettlementReport
A report that contains all of the fees that you have incurred as invoices are generated by the eBay servers. This report gives large merchants the ability to look at their fees for many listings in one file.
SoldReport
Lists all items that have been sold by this seller (sold items that were submitted to the Large Merchant Service by the seller's application).

When an item is sold, the eBay application creates an 'order' for the seller. If only one item is sold, there is one order ID and one line item ID associated with the sale. However, if multiple items are sold as part of the same transaction, there is one order ID for the sale, and multiple line item IDs - one line item ID for each item sold.

Therefore, the Sold Report returns the order IDs and line item IDs for every order associated with the seller who is making the request. Sellers use this information to make inventory updates and start order fulfillment.

When orders have been fulfilled, the seller will probably want to remove them from the list of all orders that comes back every time they receive a SoldReport. To do this, they can acknowledge each order that has been fulfulled (using order ID or line item ID) by uploading a list of the fulfulled order information using an OrderAck request.

After you upload a data file with an OrderAck request, the orders (or line items within an order) will no longer appear in the SoldReport. (After you send the first OrderAck call, future SoldReports that you request will only contain unacknowledged orders and line items.)
recurringJobDetail
  .frequencyInMinutes 		int Conditionally Use this element to specify job recurrence interval in minutes.
recurringJobDetail.jobStatus RecurringJobStatus Always The current state of a recurring Bulk Data Exchange job.

Applicable values:

•   Active

(out) Job is active.

•   Suspended

(out) Job is suspended. Use activateRecurringJob to restart a suspended recurring job.
recurringJobDetail
  .monthlyRecurrence 		MonthlyRecurrence Conditionally Optional element to define the recurrence interval for monthly jobs.
recurringJobDetail
  .monthlyRecurrence.dayOfMonth 		token Conditionally Specify a day of the month by number (e.g., Day_1, Day_2, Day_3, ...) up to the 28th day of the month (i.e., Day_28) or the last day of the month (i.e., Day_Last).
recurringJobDetail
  .monthlyRecurrence.timeOfDay 		time Conditionally The time of day you want the job to execute, based on a 24-hour clock and GMT. You must specify hours (HH), minutes (MM), and seconds (SS) in the form HH:MM:SS (for example, 05:00:00 for 5AM).
recurringJobDetail
  .recurringJobId 		string Always Recurring job ID, returned by call to createRecurrringJobRequest.
recurringJobDetail
  .weeklyRecurrence 		WeeklyRecurrence Conditionally Optional element to define the recurrence interval for weekly jobs.
recurringJobDetail
  .weeklyRecurrence.dayOfWeek 		token Conditionally Allowed Values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
recurringJobDetail
  .weeklyRecurrence.timeOfDay 		time Conditionally Recurring Time for the job to run ex:08:00:00.000Z



Back to top

Input Output Samples Change History User Notes
getRecurringJobs Samples

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.

Sample: Basic Call

Returns the processing status of all Bulk Data Exchange service recurring jobs submitted by the user who make this call.

Description

User megaonlinemerchant wants to check the status of the weekly reports she requested, to see if they are ready to download. She can enter a request with no job type fields, to see the status of all of her recurring jobs, or she can put specific job types in her request to see the status of only the specified job types.

As a result of this call, megaonlinemerchant will see a list of all the Bulk Data Exchange service jobs for each job type she specified in her request.

Input

In the following getRecurringJobs request sample, you will see that you can provide a date range (optional) and a job type (required). 

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<getRecurringJobsRequest xmlns="http://www.ebay.com/marketplace/services">
  <!--megaonlinemerchant is leaving this blank so she will receive job ids
   for all of her recurring jobs-->
</getRecurringJobsRequest>

Output

The response includes a Success or Failure acknowledgement, a timestamp, the version number of the Bulk Data Exchange service, job ID, file reference ID, percentage of processing completed, and the number of errors during processing for each Bulk Data Exchange service recurring job of the type that was submitted by the user who makes this call. 

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<getRecurringJobsResponse xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2008-11-05T03:47:52.124Z</timestamp>
  <recurringJobDetail>
    <recurringJobId>5000000102</recurringJobId>
    <creationTime>2008-10-28T16:13:05.000Z</creationTime>
    <frequencyInMinutes>180</frequencyInMinutes>
    <downloadJobType>SoldReport</downloadJobType>
    <jobStatus>Active</jobStatus>
  </recurringJobDetail>
  <recurringJobDetail>
    <recurringJobId>5000000701</recurringJobId>
    <creationTime>2008-11-04T20:44:36.000Z</creationTime>
    <frequencyInMinutes>120</frequencyInMinutes>
    <downloadJobType>ActiveInventoryReport</downloadJobType>
    <jobStatus>Active</jobStatus>
  </recurringJobDetail>
</getRecurringJobsResponse>



Back to top

Input Output Samples Change History User Notes
getRecurringJobs Change History
Version Description
1.2.0
2009-04-01
  • recurringJobDetail.dailyRecurrance, recurringJobDetail.weeklyRecurrance, recurringJobDetail.monthlyRecurrance (added): Recurring job types now support daily, weekly, or monthly frequencies.
1.0.0
2008-11-29
  • (added) New call



Back to top

Input Output Samples Change History User Notes
User-Contributed Notes
   
 
 
 

This document was generated with a customized version of the apireferencedocs tool.

© 2008–2010 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.