Lists all jobs that have been submitted with this Seller ID that have the job type specified in the request. You can enter a request with no job type field to see the status of all of your jobs, you can put a few job type fields in your request to see the status for specific job types, or you can put a single job type field in your request.
| 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"?> <getJobsRequest xmlns="http://www.ebay.com/marketplace/services"> <creationTimeFrom> dateTime </creationTimeFrom> <creationTimeTo> dateTime </creationTimeTo> <jobStatus> JobStatus </jobStatus> <!-- ... more jobStatus nodes here ... --> <jobType> token </jobType> <!-- ... more jobType nodes here ... --> </getJobsRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| creationTimeFrom | dateTime | Optional | Use this field to designate the start of a date/time range. By default, 30 days worth of data is returned. |
| creationTimeTo | dateTime | Optional | Use this field to designate the end of a date/time range. Defaults to current time. |
| jobStatus | JobStatus | Optional,
repeatable: [0..*] |
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. |
| jobType | token | Optional,
repeatable: [0..*] |
Job filter criteria. Default is return all job types.
|
| 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"?>
<getJobsResponse 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>
<!-- ... more jobProfile nodes here ... -->
</getJobsResponse>
| 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.
|
| 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.
|
| 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,
repeatable: [1..*] |
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.
|
| 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. |
| 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.
Returns the processing status of all Bulk Data Exchange service jobs submitted by the user who make this call.
Description
User megaonlinemerchant wants to check the status of the reports she requested, to see if they are ready to download. She can enter a request with no job type element to see the status of all of her jobs, or she can put a few job type fields in her request to see the status for specific job types, or she can put a single job type field in her request. However, it may be faster to use the 'getJobStatus' call if you are only looking for information about one job type.
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 getJobs request sample, you will see that you only need to provide a date range and a job type.
XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <getJobsRequest xmlns="http://www.ebay.com/marketplace/services"/> </getJobsRequest>
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 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"?> <getJobsResponse xmlns="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2008-10-28T02:49:25.126Z</timestamp> <jobProfile> <jobId>50000000519</jobId> <jobType>ActiveInventoryReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-21T11:23:52.000-07:00</creationTime> <completionTime>2008-10-21T11:28:08.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000749</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000189</jobId> <jobType>ActiveInventoryReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-01T16:48:58.000-07:00</creationTime> <completionTime>2008-10-01T16:54:07.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000339</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000449</jobId> <jobType>ActiveInventoryReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-17T11:06:12.000-07:00</creationTime> <completionTime>2008-10-17T11:09:55.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000659</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000079</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T18:20:23.000-07:00</creationTime> <completionTime>2008-09-26T18:23:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000169</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000119</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-29T12:18:38.000-07:00</creationTime> <completionTime>2008-09-29T12:23:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000249</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000319</jobId> <jobType>SoldReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-13T02:07:20.000-07:00</creationTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000539</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000369</jobId> <jobType>SoldReport</jobType> <jobStatus>Aborted</jobStatus> <creationTime>2008-10-13T03:22:43.000-07:00</creationTime> <completionTime>2008-10-15T14:27:37.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>0.0</percentComplete> </jobProfile> <jobProfile> <jobId>50000000099</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T18:29:52.000-07:00</creationTime> <completionTime>2008-09-26T18:32:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000209</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000109</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T18:34:22.000-07:00</creationTime> <completionTime>2008-09-26T18:38:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000229</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000129</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-29T17:04:21.000-07:00</creationTime> <completionTime>2008-09-29T17:08:04.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000269</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000249</jobId> <jobType>ReviseFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-09T11:43:26.000-07:00</creationTime> <completionTime>2008-10-09T11:44:42.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000429</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000209</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-08T14:17:01.000-07:00</creationTime> <completionTime>2008-10-08T14:19:16.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000369</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000089</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T18:26:10.000-07:00</creationTime> <completionTime>2008-09-26T18:29:03.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000189</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000269</jobId> <jobType>ReviseFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-09T13:05:48.000-07:00</creationTime> <completionTime>2008-10-09T13:10:51.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000469</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000239</jobId> <jobType>ReviseFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-09T11:39:36.000-07:00</creationTime> <completionTime>2008-10-09T11:40:50.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000409</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000059</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T17:25:14.000-07:00</creationTime> <completionTime>2008-09-26T17:29:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000129</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000159</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Failed</jobStatus> <creationTime>2008-10-01T15:22:55.000-07:00</creationTime> <completionTime>2008-10-01T15:23:31.000-07:00</completionTime> </jobProfile> <jobProfile> <jobId>50000000149</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Failed</jobStatus> <creationTime>2008-10-01T15:19:31.000-07:00</creationTime> <completionTime>2008-10-01T15:19:50.000-07:00</completionTime> </jobProfile> <jobProfile> <jobId>50000000169</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Failed</jobStatus> <creationTime>2008-10-01T15:24:57.000-07:00</creationTime> <completionTime>2008-10-01T15:25:16.000-07:00</completionTime> </jobProfile> <jobProfile> <jobId>50000000049</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T16:31:50.000-07:00</creationTime> <completionTime>2008-09-26T16:38:02.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000109</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000549</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Created</jobStatus> <creationTime>2008-10-21T14:46:24.000-07:00</creationTime> </jobProfile> <jobProfile> <jobId>50000000279</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-09T15:50:25.000-07:00</creationTime> <completionTime>2008-10-09T15:52:52.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000489</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000259</jobId> <jobType>ReviseFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-09T12:01:42.000-07:00</creationTime> <completionTime>2008-10-09T12:04:58.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000449</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000419</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-15T14:36:31.000-07:00</creationTime> <completionTime>2008-10-15T14:39:49.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000629</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000009</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Failed</jobStatus> <creationTime>2008-09-26T13:49:24.000-07:00</creationTime> <completionTime>2008-09-26T13:49:25.000-07:00</completionTime> </jobProfile> <jobProfile> <jobId>50000000509</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-21T11:13:13.000-07:00</creationTime> <completionTime>2008-10-21T11:16:08.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000739</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000409</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-15T14:31:37.000-07:00</creationTime> <completionTime>2008-10-15T14:33:49.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000609</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000069</jobId> <jobType>AddFixedPriceItem</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-09-26T17:54:47.000-07:00</creationTime> <completionTime>2008-09-26T17:59:03.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000149</fileReferenceId> </jobProfile> <jobProfile> <jobId>50000000389</jobId> <jobType>ActiveInventoryReport</jobType> <jobStatus>Completed</jobStatus> <creationTime>2008-10-13T04:07:53.000-07:00</creationTime> <completionTime>2008-10-13T04:09:10.000-07:00</completionTime> <errorCount>0</errorCount> <percentComplete>100.0</percentComplete> <fileReferenceId>50000000569</fileReferenceId> </jobProfile> </getJobsResponse>
| Input Output Samples |
| Version | Description |
|---|---|
| 1.0.0 2008-11-29 |
|
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.