eBay Bulk Data Exchange API
|
Begins processing the data in the uploaded file. For example, if the data file contains data for the AddFixedPriceItem request, the Bulk Data Exchange web service reads and sends this item data from the uploaded file to the eBay Trading platform. (Adds the Fixed Price Items to the eBay web site.)
| Output Samples Change History User Notes |
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"?> <startUploadJobRequest xmlns="http://www.ebay.com/marketplace/services"> <jobId> string </jobId> </startUploadJobRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| jobId | string | Required |
Unique ID assigned by the Bulk Data Exchange service for managing your upload job. Use the jobId value returned in the createUploadJob response. You can also use getJobs to retrieve job IDs for any upload jobs you have created. Before you can start an upload job, you must upload the corresponding data file, using the File Transfer API. In the File Transfer API, jobId maps to taskReferenceId in the uploadFile call. Once you start your upload job, use getJobStatus to monitor processing progress. |
| Input Samples Change History User Notes |
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"?>
<startUploadJobResponse 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>
</startUploadJobResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Standard Output 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.
|
| 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 | 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. |
| Input Output Change History User Notes |
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.
Begins the Bulk Data Exchange service processing for data files that have been uploaded successfully.
Description
User megaonlinemerchant wants to start the processing for the data file that contains her AddFixedPriceItem calls. She has just uploaded this file to the eBay servers using the File Transfer service UploadFile call.
As a result of this call, megaonlinemerchant will begin to monitor the status of the processing, so that she will know when to download the file that contains the AddFixedPriceItem response data.
Input
In the following startUploadJob request sample, you will see that you only need to enter the job id associated with the file that is to be processed.
XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <startUploadJobRequest xmlns="http://www.ebay.com/marketplace/services"> <jobId>50000002126</jobId> </startUploadJobRequest>
Output
The response includes a Success or Failure acknowledgement, the version number of the Bulk Data Exchange service, and a timestamp. It is easy to assume that the startUploadJob response contains the AddFixedPriceItem response data. Remember that this is not the case - the AddFixedPriceItem response data is a file that you have to download using the File Transfer service after the processing for this job has completed.
XML format. Also available are the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <startUploadJobResponse xmlns="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2008-11-04T03:08:36.663Z</timestamp> </startUploadJobResponse>
| Input Output Samples User Notes |
| Version | Description |
|---|---|
| 1.0.0 2008-11-29 |
|
| Input Output Samples Change History User 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.