File Transfer API

File Transfer API Release Notes

You can find links to the File Transfer API documentation in the top navigation bar. Information about the schema location is in the Schema Location section of the "Making an API Call" topic.

Are you new to the Large Merchant Services solution?

If so, see Large Merchant Services User Guide -- an introduction to the eBay Large Merchant Services solution

Are you just getting started with the eBay Developer's Program?

The following links provide useful information for beginners:

Q2 2009   Q4 2008  
Version Release Date   Version Release Date  
1.1.0 2009-4-1 1.0.0 2008-11-12

Special Configuration Information

This section includes configuration information where specific setup steps are needed.

Optional CONTENT-TYPE Header Must Have Correct Value

As of January 15, 2010, eBay evaluates the CONTENT-TYPE header against the request payload format. If the CONTENT-TYPE value is incorrect for the payload, the request will fail. Previously, eBay did not validate the CONTENT-TYPE header in requests.

This HTTP header is optional. If you do not submit the CONTENT-TYPE header with your request, eBay will determine the content type from the payload.

The following table lists the correct CONTENT-TYPE header values for HTTP POST request formats:

Request Payload Format CONTENT-TYPE Value
XML text/xml
SOAP11 application/soap+xml
SOAP12 text/xml (together with SOAPAction header being sent - value can be anything)

See Making an API Call for more information about the call format for the File Transfer API.

HTTP Property for Java SOAP Client

FileTransferService calls made by a Java SOAP client need to have the HTTP Chunked property set to false.

Add the line as below inside the upload and download method: testStub._getServiceClient().getOptions().setProperty(org.apache.axis2.transport.http.HTTPConstants.CHUNKED, Boolean.FALSE);

Here is a sample method that implements the line above:

public static boolean downloadFile(String fileSaveToPath, String task_ref_id, String file_ref_id)
    throws AxisFault, RemoteException, Exception {

  String authToken=LMSProperties.getInstance().getAuthToken();
  String endPointURL=LMSProperties.getInstance().getFtsEndPointURL();
  ServiceClient testStub = new ServiceClient(endPointURL);
  testStub._getServiceClient().getOptions().setProperty(Constants.Configuration.ENABLE_MTOM, Constants.VALUE_TRUE);
  testStub._getServiceClient().getOptions().setProperty(org.apache.axis2.transport.http.HTTPConstants.CHUNKED,
  Boolean.FALSE);
  testStub._getServiceClient().getOptions().setTimeOutInMilliSeconds(
  LMSProperties.getInstance().getTimeOutInMilliSeconds());

  //put in HTTP Headers
  ...
}

This example assumes that ServiceClient extends the com.ebay.www.marketplace.services.FileTransferServiceStub.UploadFileResponseE generated Stub class


Back to top

Version 1.1.0

Index of Changed Calls - 1.1.0

Schema Changes - 1.1.0

Announcements - 1.1.0

New Features - 1.1.0

Changed Functionality - 1.1.0

Documentation Changes and Errata - 1.1.0

For a current list of known issues, see Site Status and the Knowledge Base.

Index of Changed Calls - 1.1.0

These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.

New Calls

No new calls in this release.

Changed Calls

No changed calls in this release.

Schema Changes - 1.1.0

Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.

None for this release. Bug fixes only. See Site Status for details.

Announcements - 1.1.0

None for this release.

Change Requests

For a current list of known issues, see Site Status and the Knowledge Base.

New Features - 1.1.0

This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.

For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 607.

None for this release.

Changed Functionality - 1.1.0

This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.

None for this release.

Documentation Changes and Errata - 1.1.0

This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1.1.0 and Changed Functionality - 1.1.0.

None for this release.

Version 1.0.0

This is the first release of the eBay File Transfer API.

For a current list of known issues, see Site Status and the Knowledge Base.

Index of Changed Calls - 1.0.0

These calls are included in the initial release of the eBay File Transfer API.

New Calls




Copyright © 2008–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.