eBay Bulk Data Exchange APIVersion 1.5.0

getRecurringJobExecutionStatus

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



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">
  <!-- Call-specific Input Fields -->
  <recurringJobId> string </recurringJobId>
</getRecurringJobExecutionStatusRequest>
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.



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">
  <!-- Call-specific Output Fields -->
  <jobProfile> JobProfile
    <completionTime> dateTime </completionTime>
    <creationTime> dateTime </creationTime>
    <errorCount> int </errorCount>
    <fileReferenceId> string </fileReferenceId>
    <jobId> string </jobId>
    <jobStatus> JobStatus </jobStatus>
    <jobType> token </jobType>
    <percentComplete> double </percentComplete>
  </jobProfile>
  <!-- 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>
</getRecurringJobExecutionStatusResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
jobProfile JobProfile Always A jobProfile container is returned for a successfully retrieved recurring job. The jobProfile container consists of unique identifiers for the recurring job, as well as data that indicates the current status of the recurring job.

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 This timestamp indicates the date and time that the Bulk Data Exchange job was completed. Compare this timestamp against creationTime to determine the average processing time for your jobs. If processing of the job has not completed, this field will not be returned. The user will have to look at the percentComplete value to determine the current status of the running job.
jobProfile.creationTime dateTime Always This timestamp indicates the date and time that the Bulk Data Exchange job was created. This value is always returned with the jobProfile container.
jobProfile.errorCount int Conditionally The number of non-fatal (informational) errors that occurred during file processing (uploads or reports) after a startUploadJobRequest or startDownloadJobRequest call.
jobProfile.fileReferenceId string Conditionally A unique ID assigned to a file by the Bulk Data Exchange API. This value will be passed into the fileReferenceId field in the File Transfer API's uploadFile call.

If a job has not completed processing, only the inputFileReferenceId value (from the createUploadJob response) will be returned. Once the upload job has finished processing, a new fileReferenceId is assigned by the Bulk Data Exchange API and returned by the job status calls.
jobProfile.jobId string Always Unique ID that is assigned for a job by the Bulk Data Exchange API after a successful startDownloadJob call. This value is always returned with the jobProfile container.
jobProfile.jobStatus JobStatus Always The current state of a Bulk Data Exchange job. This value is always returned with the jobProfile container.

Applicable values: See jobStatus.
jobProfile.jobType token Always Each of the Bulk Data Exchange job types corresponds to a Merchant Data request or response with the same name. The requests or responses are included within a data file that will be uploaded or downloaded after the job is created. For instance, if you create an AddFixedPriceItem job, then the file you are going to upload must contain AddFixedPriceItem requests - one request for each item in your data file.

Each Bulk Data Exchange job can only have one job type per job. For example, if you are uploading a data file, it can not have both AddFixedPriceItem requests and ReviseFixedPriceItem requests within the same data file.

The following value definitions describe the request or response associated with each job type.

For more information about creating and uploading Merchant Data files, see the Large Merchant Services User Guide.

Applicable values:
ActiveInventoryReport
Download job for 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
Upload job for requests to add fixed-price items and lists it on a specified eBay site.
AddItem
Upload job for requests to Defines a single new item and lists it on a specified eBay site.
EndFixedPriceItem
Upload job for requests to end specified fixed-price item listings before the date and time at which they would normally end (per the listing duration).
EndItem
Upload job for requests to end specified item listings before the date and time at which they would normally end (per the listing duration).
FeeSettlementReport
Download job for a report that contains all of the fees the seller has 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.
OrderAck
Upload job for requests that acknowledge orders have been received. Use the OrderAck request to acknowledge each line item in a SoldReport by order ID or line item ID.

After you send the first OrderAck call, future SoldReports will only contain unacknowledged orders or line items.
RelistFixedPriceItem
Upload job for requests to re-list fixed-price (single or multi-item) listings that ended without buyers. A 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
Upload job for requests to re-list listings that ended without winning bidders or buyers. Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site.
ReviseFixedPriceItem
Upload job for requests to change the properties of a currently active listing.

If the listing contains multiple items, you can revise most of the fields in the listing (except Title, currency, product ID, photo display type, variation details, duration, format, or eBay Giving Works charity), even after one of the items in the listing has been purchased. To revise multiple listings, include a ReviseFixedPriceItemRequest once for each item or listing in your data file, with new information for each item or listing.
ReviseInventoryStatus
Upload job for requests to change the price and quantity of a currently active fixed-price listing. Inputs are the item IDs or SKUs of the listings being revised, and price and quantity that are being changed for each revision.

You can use SKU as input only for fixed-price listings that are managed by SKU (i.e., InventoryTrackingMethod is set to SKU). ItemID can be used in either case.
ReviseItem
Upload job for requests to change the properties of active listings.
SetShipmentTrackingInfo
Upload job for requests to specify the shipment tracking information associated with one package of an order.
SoldReport
Download job for a report that 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.)
UploadSiteHostedPictures
Upload job for requests to upload pictures to EPS (eBay Picture Services). Each request contains 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 request.
VerifyAddFixedPriceItem
Upload job for requests to test the definition of new fixed-price items by submitting them to eBay without creating a listing.
VerifyAddItem
Upload job for requests to test the definition of new items and submit the definition to eBay without creating a listing.


Recurring jobs can be established for download job types only. For getRecurringJobExecutionHistory and getRecurringJobExecutionStatus, only the following values apply:

  • ActiveInventoryReport
  • FeeSettlementReport
  • SoldReport
jobProfile.percentComplete double Always The percentage of your file that has been processed after startUploadJobRequest or startDownloadJobRequest call. This value is always returned with the jobProfile container whether the job is still in progress or complete. If the job is complete, the value of this field will be '100.0'.
Standard Output Fields  
ack AckValue Always Returns the acknowledgement of the call success or failure.

Applicable values:

Failure
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
Reserved for future use.
Success
The request was processed successfully, but something occurred that may affect your application or the user.
Warning
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
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
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
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 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:

Error
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
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 Bulk Data Exchange API.
MarketplaceCommon
The error is common to all Marketplace API.
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.



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. Also available is 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 is 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>



Change History

Change Date Description
1.0.0
2008-11-29
  • (added) New call