getJobStatus

Get job status for the provided job ID.



Back to top

Input Output Samples Change History User Notes
getJobStatus 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"?>
<getJobStatusRequest xmlns="http://www.ebay.com/marketplace/services">
  <jobId> string </jobId>
</getJobStatusRequest>
Argument Type Occurrence Meaning
jobId string Required Unique ID assigned by the Bulk Data Exchange service for managing your upload or download job. Use the jobId value returned in the createUploadJob response or the startDownloadJob response. You can also use getJobs to retrieve job IDs for any of your upload or download jobs.



Back to top

Input Output Samples Change History User Notes
getJobStatus 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"?>
<getJobStatusResponse 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 ... -->
</getJobStatusResponse>
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
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 that references the response file when the job created via createUploadJob or startDownloadJob completes. Pass the fileReferenceId into a File Transfer Service uploadFile or downloadFile 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 Always The inputFileReferenceId is a unique ID that references the input data file for a job that is created via createUploadJob. Preserves the original fileReferenceId value for an upload job. Once the data file has been uploaded and the upload job has finished processing, a new fileReferenceId is assigned by the Bulk Data Exchange Service for downloading the corresponding responses.
jobProfile.jobId string Always Job Id obtained by calling createUploadJob.
jobProfile.jobStatus JobStatus Always The current state of a Bulk Data Exchange job.

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 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:
AddFixedPriceItem
Defines a single new fixed price item and lists it on a specified eBay site.
AddItem
Defines a single new item and lists it on a specified eBay site.
EndFixedPriceItem
Ends the specified item listing before the date and time at which it would normally end (per the listing duration).
EndItem
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 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
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.

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
Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site.
ReviseFixedPriceItem
Enables a seller 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
Enables a seller 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
Enables a seller to change the properties of a currently active listing.
SetShipmentTrackingInfo
Includes information about a specific item and the shipping information associated with it.
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 request.
VerifyAddFixedPriceItem
Acknowledges that the data for a single new fixed price item matches the schema and can be added without data errors.
VerifyAddItem
Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.
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 User Notes
getJobStatus 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 job.

Description

User megaonlinemerchant wants to check the status of her 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 job that she specified in her request.

Input

In the following getJobsStatus 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'?>
<getJobStatusRequest xmlns="http://www.ebay.com/marketplace/services">
  <jobId>50000000266</jobId>
</getJobStatusRequest>

Output

The response includes a Success or Failure acknowledgement, the version number of the Bulk Data Exchange service, a timestamp, and the job profile, which includes: 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'?>
<getJobStatusResponse xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2008-11-05T03:37:19.304Z</timestamp>
  <jobProfile>
    <jobId>50000000266</jobId>
    <jobType>AddFixedPriceItem</jobType>
    <jobStatus>Completed</jobStatus>
    <creationTime>2008-11-04T21:58:04.000Z</creationTime>
    <completionTime>2008-11-04T22:01:46.000Z</completionTime>
    <errorCount>0</errorCount>
    <percentComplete>100.0</percentComplete>
    <fileReferenceId>50000000506</fileReferenceId>
  </jobProfile>
</getJobStatusResponse>



Back to top

Input Output Samples Change History User Notes
getJobStatus Change History
Version Description
1.4.1
2010-04-14
  • jobType values (added): New job types (AddItem, EndItem, RelistItem, ReviseItem, and VerifyAddItem) for corresponding data file payloads newly supported by the Merchant Data API.
1.4.0
2009-07-22
  • inputFileReferenceId (added): Preserves the original fileReferenceId value for an upload job. Once the upload job has finished processing, a new fileReferenceId is assigned by the Bulk Data Exchange Service for downloading the corresponding responses.
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.