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.
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"?> <uploadFileRequest xmlns="http://www.ebay.com/marketplace/services"> <!-- Call-specific Input Fields --> <fileAttachment> FileAttachment <Data> base64Binary </Data> <Size> long </Size> </fileAttachment> <fileFormat> token </fileFormat> <fileReferenceId> string </fileReferenceId> <taskReferenceId> string </taskReferenceId> </uploadFileRequest>
Argument | Type | Occurrence | Meaning |
---|
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.
|
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. |
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"?> <uploadFileResponse xmlns="http://www.ebay.com/marketplace/services"> <!-- (No call-specific Output fields) --> <!-- 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 allowed here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes allowed here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> </uploadFileResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
Standard Output Fields |
ack | AckValue | Always |
Indicates the success or failure of transferring data to eBay's servers.
Applicable values: |
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: |
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 | 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.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: |
errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain upon which the error occurred.
|
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. |
Input Output Change History |
Code samples not yet added for this call's documentation.
Input Output Samples |
Change Date | Description |
---|---|
1.0.0 2008-11-29 |
|
Copyright © 2013–2016 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.