JobProfile
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.

Types that use JobProfile:

Calls that use one or more fields of JobProfile:

Fields

completionTime ( dateTime )
creationTime ( dateTime )
errorCount ( int )
fileReferenceId ( string )
inputFileReferenceId ( string )
jobId ( string )
jobStatus ( JobStatus )
jobType ( token )
percentComplete ( double )

completionTime ( dateTime ) [0..1]
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.
See the Field Index to learn which calls use completionTime.

creationTime ( dateTime ) [?..1]
The date and time a Bulk Data Exchange job was created.
See the Field Index to learn which calls use creationTime.

errorCount ( int ) [0..1]
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.
See the Field Index to learn which calls use errorCount.

fileReferenceId ( string ) [0..1]
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.
See the Field Index to learn which calls use fileReferenceId.

inputFileReferenceId ( string ) [0..1]
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.
See the Field Index to learn which calls use inputFileReferenceId.

jobId ( string ) [?..1]
Job Id obtained by calling createUploadJob.
See the Field Index to learn which calls use jobId.

jobStatus ( see JobStatus for possible values ) [?..1]
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.
See the Field Index to learn which calls use jobStatus.

jobType ( token ) [?..1]
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.
See the Field Index to learn which calls use jobType.

percentComplete ( double ) [0..1]
The percentage of your file that has been processed after sending the Bulk Data Exchange startUploadJobRequest call or the startDownloadJobRequest call.
See the Field Index to learn which calls use percentComplete.

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.