getRecurringJobExecutionStatus

Returns the status information for the latest instance of a Recurring Job. To see all instances of a Recurring Job, use getRecurringJobExecutionHistory.



Back to top

Input Output Samples Change History
getRecurringJobExecutionStatus Input

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"?>
<getRecurringJobExecutionStatusRequest xmlns="http://www.ebay.com/marketplace/services">
  <recurringJobId> string </recurringJobId>
</getRecurringJobExecutionStatusRequest>
Argument Type Occurrence Meaning
recurringJobId string Required Recurring job ID, returned by call to createRecurrringJob operation.



Back to top

Input Output Samples Change History
getRecurringJobExecutionStatus 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"?>
<getRecurringJobExecutionStatusResponse 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 -->
  <jobProfile> JobProfile 
    <completionTime> dateTime </completionTime>
    <creationTime> dateTime </creationTime>
    <errorCount> int </errorCount>
    <fileReferenceId> string </fileReferenceId>
    <inputFileReferenceId> string </inputFileReferenceId>
    <jobId> string </jobId>
    <jobStatus> JobStatus </jobStatus>
    <jobType> token </jobType>
    <percentComplete> double </percentComplete>
  </jobProfile>
</getRecurringJobExecutionStatusResponse>
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 Information for an error or warning that occurred when eBay processed the request.
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 The data and time of the response.
version string Always The version of the schema that your WSDL is based on.
Call-specific Output Fields
jobProfile JobProfile Always The job profile is a collection of data about a job that includes: jobId, jobType, jobStatus, job creation time, job completion time, errorCount, percentComplete, and inputFileReferenceId (for upload jobs).

If upload job processing has finished, a new fileReferenceId is also returned.

The job profile returns data about the state of the Bulk Data Exchange job, but does not return information about the status of the processing for any data file that is sent with the job request or returned with the job response.
jobProfile.completionTime dateTime Conditionally The date and time that job processing was completed. Use this with creationTime to determine the average processing time for your jobs. If job processing has not completed, this field will not be returned.
jobProfile.creationTime dateTime Always The date and time a Bulk Data Exchange job was created.
jobProfile.errorCount int Conditionally The number of non-fatal (informational) errors that occurred during file processing (uploads or reports) after you sent the Bulk Data Exchange startUploadJobRequest call or the startDownloadJobRequest call.
jobProfile.fileReferenceId string Conditionally A unique ID assigned to a file by the Bulk Data Exchange service when createUploadJobRequest is called. Pass this fileReferenceId into a File Transfer service uploadFileRequest call.

If a job has not completed processing, only the inputFileReferenceId (original fileReferenceId from the createUploadJobResponse) will be returned. Once the upload job has finished processing, a new fileReferenceId is assigned by the Bulk Data Exchange service and returned by the job status calls.
jobProfile
  .inputFileReferenceId 		string Conditionally The fileReferenceId is a unique ID assigned to a file by the Bulk Data Exchange service when createUploadJobRequest is called. It is also returned by the getJobs, getJobStatus, getRecurringJobExecutionStatus, and getRecurringJobExecutionHistory calls as the 'inputFileReferenceId', so you can retrieve the ID if you no longer have your results from the createUploadJob call.

Pass this inputFileReferenceId into a File Transfer service uploadFileRequest.

Once the job processing is finished, a new fileReferenceId is assigned by the Bulk Data Exchange service and returned by the job status calls.
jobProfile.jobId string Always Job Id obtained by calling createUploadJob.
jobProfile.jobStatus JobStatus Always Returns the current state of a Bulk Data Exchange Job. Use getJobStatus to find out where your job is in the processing cycle. Default is to return status for all jobs.

Applicable values:

•   Aborted

(in/out) The Bulk Data Exchange has been aborted due to the abortJobRequset call.

•   Completed

(in/out) Processing on the data file or the report has finished.

•   Created

(in/out) The job ID and file reference ID have been created as a result of the createUploadJobRequest or the startDownloadJobRequest.

•   Failed

(in/out) The Bulk Data Exchange job has not completed successfully, due to incorrect data format, request errors, or Bulk Data Exchange service errors.

•   InProcess

(in/out) Processing on the data file or the report has begun.

•   Scheduled

(in/out) The job has been internally scheduled for processing by the Bulk Data Exchange service.
jobProfile.jobType token Always Specifies the Merchant Data API call used in a Bulk Data Exchange service job. Each Bulk Data Exchange job can only have one jobType per job. For instance, if you are uploading a data file it can not have an AddFixedPriceItem calls and ReviseFixedPriceItem calls within the same 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.
AddFixedPriceItem
Defines a single new fixed price item and lists it on a specified eBay site. To list multiple new items, execute AddFixedPriceItemRequestType once for each item, with a new item definition each time.
EndFixedPriceItem
Ends the specified item listing before the date and time at which it would normally end (per the listing duration).
OrderAck
Request that acknowledges that an order has been received. Use the OrderAck job to acknowledge each line item in a SoldReport by order or line item. After you send the first OrderAck call, future SoldReports will only contain unacknowledged orders and line items.
RelistFixedPriceItem
Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site. The listing may be re-listed with the same item properties as the original or the seller may change a number of the item's defining properties at re-listing time. The new listing will have a different item ID than the original one. RelistItem re-lists a single item (or a single multi-item listing) that has already ended. To re-list multiple items (multiple listings) that have ended, execute RelistFixedPriceItem once for each ended listing.
ReviseFixedPriceItem
Enables a seller to change the properties of a currently active listing. Include the item ID of the ended item being revised and any properties that are being changed for the revision.
ReviseInventoryStatus
Enables a seller to change the price and quantity of a currently active fixed-price listing. Inputs are the item IDs and SKUs of the listings being revised, and price and quantity that are being changed for each revision. Only applicable to fixed-price listings that include a SKU.
SetShipmentTrackingInfo
Includes information about a specific item and the shipping information associated with it.
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) y 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.)
UploadSiteHostedPictures
Uploads a picture to EPS (eBay Picture Services) when you supply a URL in the ExternalPictureURL field (the location of the picture on an external web server). Unlike what the call name implies, you can only upload one picture per call.
jobProfile.percentComplete double Always The percentage of your file that has been processed after sending the Bulk Data Exchange startUploadJobRequest call or the startDownloadJobRequest call.



Back to top

Input Output Samples Change History
getRecurringJobExecutionStatus 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 a specified Bulk Data Exchange service recurring job.

Description

User megaonlinemerchant wants to check the status of her weekly SoldReport, to see if it is ready to download.

As a result of this call, megaonlinemerchant will see whether processing is scheduled, completed, or aborted for the recurring job number that she specified in her request.

Input

In the following getRecurringJobExecutionStatus request sample, you will see that you only need to provide the Job ID in your request. 

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

<?xml version="1.0" encoding="utf-8"?>
<getRecurringJobExecutionStatusRequest xmlns="http://www.ebay.com/marketplace/services">
  <recurringJobId>5000000800</recurringJobId>
</getRecurringJobExecutionStatusRequest>

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. 

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

<?xml version="1.0" encoding="utf-8"?>
   <getRecurringJobExecutionStatusResponse xmlns="http://www.ebay.com/marketplace/services">
      <ack>Success</ack>
      <version>1.0.0</version>
      <timestamp>2008-12-04T04:24:04.713Z</timestamp>
      <jobProfile>
         <jobId>50000000783</jobId>
         <jobType>SoldReport</jobType>
         <jobStatus>Completed</jobStatus>
         <creationTime>2008-12-04T04:10:15.000Z</creationTime>
         <completionTime>2008-12-04T04:13:56.000Z</completionTime>
         <errorCount>0</errorCount>
         <percentComplete>100.0</percentComplete>
         <fileReferenceId>50000001363</fileReferenceId>
      </jobProfile>
   </getRecurringJobExecutionStatusResponse>



Back to top

Input Output Samples Change History
getRecurringJobExecutionStatus Change History
Version Description
1.0.0
2008-11-29
  • (added) New call

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

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