uploadFile - Call Reference - eBay File Transfer API

uploadFile

Transfers a data file to one of eBay's servers. After your application makes this call, it needs to make the Bulk Data Exchange 'StartUploadJob' call so the data can be processed.

uploadFile 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"?>
<uploadFileResponse 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>
</uploadFileResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields

ack	AckValue	Always	Indicates the success or failure of transferring data to eBay's servers. 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) The request that triggered the error was processed successfully but there is some error in the application or data. • 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 outage. An application can retry the request 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 Merchandising 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 list 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: Merchandising The error is specific to the Merchandising service. MarketplaceCommon The error is common to all Marketplace services.
timestamp	dateTime	Always	The date and time that the response was sent.
version	string	Always	The version of the schema that your WSDL is based on.

uploadFile 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

Transfers data files to the eBay site with the Large Merchant Services solution. This sample represents a request to upload a compressed data file using the File Transfer Service.

Description

User magicalbookseller wants to upload the data file she created with the AddFixedPriceItem data for her Harry Potter books and music CDs that she wants to list on the eBay US site. Before she can upload a data file, she has to make a Bulk Data Exchange createUploadJob call and specify that she wants to upload an AddFixedPriceItem job. After magicalbookseller has received a successful response for this File Transfer service uploadFile call, she will need to make a Bulk Data Exchange startUploadJob call to begin the file processing.

An uploadFile request needs a task ID, a file reference ID, and a UUID.

As a result of this call, magicalbookseller has new listings on eBay with the details provided in the data file that she uploaded.

Input

The fields in the following upFile request are included to represent a request to upload an attached data file for magicalbookseller's listings.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

POST /FileTransferService HTTP/1.1
Content-type: multipart/related; boundary=
MIMEBoundaryurn_uuid_C0FC77A812E40EAE841226969745133;type="application/xop+xml";start="<0.
urn:uuid:883CA9C91CE9C469D912223894056542>";start-info="text/xml"
X-EBAY-SOA-SERVICE-NAME: FileTransferService
X-EBAY-SOA-OPERATION-NAME: uploadFile
X-EBAY-SOA-SECURITY-TOKEN: ABC...123
X-EBAY-SOA-REQUEST-DATA-FORMAT: XML
X-EBAY-SOA-RESPONSE-DATA-FORMAT: XML
User-Agent: Jakarta Commons-HttpClient/3.1
Host: beta.storage.sandbox.ebay.com:8082
Content-Length: 2680

--MIMEBoundaryurn_uuid_C0FC77A812E40EAE841226969745133
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml; charset=UTF-8"
Content-Transfer-Encoding: binary
Content-ID: <0.urn:uuid:883CA9C91CE9C469D912223894056542>

<?xml version='1.0' encoding='UTF-8'?><uploadFileRequest 
xmlns:sct="http://www.ebay.com/soaframework/common/types" 
xmlns="http://www.ebay.com/marketplace/services"><taskReferenceId>
50000005119</taskReferenceId><fileReferenceId>50000009769</fileReferenceId><fileFormat>
gzip</fileFormat><fileAttachment><Data><xop:Include 
xmlns:xop="http://www.w3.org/2004/08/xop/include" 
href="cid:urn:uuid:EE69C2F1D5C814ADF71222389408640" /></Data> </fileAttachment>
</uploadFileRequest>
--MIMEBoundaryurn_uuid_C0FC77A812E40EAE841226969745133
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
Content-ID: <urn:uuid:EE69C2F1D5C814ADF71222389408640>

�

Output

The response includes information about the web server, header data, encoding information, Success or Failure acknowledgement, a timestamp, and the version number of the File Transfer service.

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<uploadFileResponse xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2008-11-06T01:33:07.198Z</timestamp>
</uploadFileResponse>

uploadFile Change History

Version	Description
1.0.0 2008-11-29	(added) New call

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool.

fileAttachment	FileAttachment	Required	The zipped report file that is encoded in Base64 Binary format and included in the request according to the SOAP MTOM standard.
fileAttachment.Data	base64Binary	Required	The data in the attached file. When this is returned in downloadFile and you are working with Large Merchant Services or GetCategorySpecifics, the attached file is a .zip file.
fileAttachment.Size	long	Required	This is the size of the file you are attaching (that contains the Merchant Data API or Trading API requests that you want to upload) or of the file you are receiving as a download. The default maximum size for a data file attachment in the File Transfer uploadJob call is 15MB, If you have a large call limit and you want to send more calls than would fit in a 15MB file, you will have to divide your data into multiple uploads.
fileFormat	token	Required	Specifies the format of the file being uploaded. gzip It specifies that the file to be uploaded is in gzip format zip It specifies that the file to be uploaded is in zip format.
fileReferenceId	string	Required	A unique ID assigned to a file by the Bulk Data Exchange service when createUploadJobRequest is called. Pass the fileReferenceId into a File Transfer service uploadFile call. The File Transfer Service uses this identifier to keep track of the files that are uploaded.
taskReferenceId	string	Required	This is an external identifier used by a service that interacts with the File Transfer Service. For instance, the Bulk Data Exchange Service uses a job ID as a primary identifier, so, if you're using the Bulk Data Exchange Service, enter the job ID as the taskReferenceId.

eBay File Transfer API Call Reference Version 1.1.0

eBay File Transfer API
Call Reference Version 1.1.0