Bulk Data Exchange API

Bulk Data Exchange API Release Notes

You can find links to the Bulk Data Exchange 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:

Version Release Date  
1.5.0 2013-10-24
1.4.1 2009-08-19
1.4.0 2009-07-22
1.2.0 2009-04-01
1.1.0 2009-02-18
1.0.0 2008-11-12


Back to top

Version 1.5.0

Index of Changed Calls - 1.5.0

Schema Changes - 1.5.0

Announcements - 1.5.0

New Features - 1.5.0

Changed Functionality - 1.5.0

Documentation Changes and Errata - 1.5.0

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

Index of Changed Calls - 1.5.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

Schema Changes - 1.5.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.

Name Part of Schema Type of Change
DownloadJobRecurringFilter Complex type New
OrderReportFilter Complex type New
OrderReportRecurringFilter Complex type New
downloadRequestFilter.orderReportFilter Element New
downloadRequestFilter.soldReportFilter Element New
ListingType Enumerated type New
OrderStatusTypes Enumerated type New
CreateRecurringJobRequest.downloadJobRecurringFilter Element New
SoldReportFilter Type New
IncludeShippingAddressType Type New

Announcements - 1.5.0

Change Requests

See the Site Status Updates for bug fixes related to this release.

New Features - 1.5.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 - 1.5.0.

New Sold Report Filter

The new soldReportFilter container allows the user to control whether (and when) the buyers' shipping address information is returned in the SoldReport response in Merchant Data calls. The includeShippingAddress enumeration value will control whether shipping addresses are always returned, or only returned after order checkout is complete.

New Order Report Filter

The orderReportFilter container allows the user to control which orders are retrieved in an Order Report. There are creation time and modification time date filters, an order status filter, a listing type filter (used to retrieve Half.com orders), and an includeFinalValueFee boolean that controls whether or not a line item's Final Value Vee is returned in the report.

Changed Functionality - 1.5.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.5.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.5.0 and Changed Functionality - 1.5.0.

None for this release.

Back to top

Version 1.4.1

Index of Changed Calls - 1.4.1

Schema Changes - 1.4.1

Announcements - 1.4.1

New Features - 1.4.1

Changed Functionality - 1.4.1

Documentation Changes and Errata - 1.4.1

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

Index of Changed Calls - 1.4.1

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

Schema Changes - 1.4.1

Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.

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.

Announcements - 1.4.1

None for this release.

Change Requests

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

New Features - 1.4.1

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

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.

New Upload Job Types to Support Merchant Data API Changes

As of mid-April (release 665), the Merchant Data API is no longer limited to fixed-price listing APIs. For example, you can now use AddItem to list auctions.

Here are the new values supported by the uploadJobType field:

Each of these job types corresponds to a call of the same name in the Trading API.

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 text/xml (together with the SOAPAction header, for which the value can be anything)
SOAP12 application/soap+xml

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

Documentation Changes and Errata - 1.4.1

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

Platform Notification for Job Completion

The Bulk Data Exchange Service can be used in conjunction with the Trading API Platform Notification feature. When you subscribe to the BulkDataExchangeJobCompleted event, you will be notified when the processing for your jobs has finished. See Large Merchant Services Users Guide for details about how to subscribe.

Cardinality Changed for fileReferenceId with Job Status Calls

Since the fileReferenceId is only returned in job status calls when the job processing has completed, the value 'Always' was changed to 'Conditionally' in the Details table.

Back to top

Version 1.4.0

Index of Changed Calls - 1.4.0

Schema Changes - 1.4.0

Announcements - 1.4.0

New Features - 1.4.0

Changed Functionality - 1.4.0

Documentation Changes and Errata - 1.4.0

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

Index of Changed Calls - 1.4.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.4.0

Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.

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.

Name Part of Schema Type of Change
getJobs.inputFileReferenceId Element Added
getJobStatus.inputFileReferenceId Element Added
getRecurringJobExecutionStatus.inputFileReferenceId Element Added
getRecurringJobExecutionHistory.inputFileReferenceId Element Added

Announcements - 1.4.0

None for this release.

Change Requests

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

New Features - 1.4.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.

Get Status Calls Return inputFileReferenceId

If you misplace the original fileReferenceId that is returned with the createUploadJob response, you can use a job status call to retrieve it as the inputFileReferenceId. The inputFileReferenceId can be retrieved using any of the following calls: getJobs, getJobStatus, getRecurringJobExecutionStatus, and getRecurringJobExecutionHistory. The inputFileReferenceId is only returned in the job status of upload jobs.

Changed Functionality - 1.4.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.4.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.4.0 and Changed Functionality - 1.4.0.

None for this release.

Back to top

Version 1.2.0

Index of Changed Calls - 1.2.0

Schema Changes - 1.2.0

Announcements - 1.2.0

New Features - 1.2.0

Changed Functionality - 1.2.0

Documentation Changes and Errata - 1.2.0

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

Index of Changed Calls - 1.2.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.2.0

Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.

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.

Name Part of Schema Type of Change
createRecurringJobs.dailyRecurrance Element Added
createRecurringJobs.weeklyRecurrance Element Added
createRecurringJobs.monthlyRecurrance Element Added
recurringJobDetail.dailyRecurrance Element Added
recurringJobDetail.weeklyRecurrance Element Added
recurringJobDetail.monthlyRecurrance Element Added

Announcements - 1.2.0

None for this release.

Change Requests

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

New Features - 1.2.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.

New Recurrance Controls for Recurring Job Types

You can now request daily, weekly, or monthly, frequency for recurring job types by including dailyRecurrance, weeklyRecurrance, or monthlyRecurrance tags in the createRecurringJobs and getRecurringJobs calls.

Changed Functionality - 1.2.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.2.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.2.0 and Changed Functionality - 1.2.0.

None for this release.

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 Updates 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

Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.

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.

Name Part of Schema Type of Change
GetItemInfoReportFilter Complex Type Reserved for Future Use
GetItemJobActionType Complex Type Reserved for Future Use
ItemEventType Enumerated Type Reserved for Future Use
DownloadRequestFilter.getItemInfoReportFilter Element Reserved for Future Use

Announcements - 1.1.0

None for this release.

Change Requests

For a current list of known issues, see Site Status Updates 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.

FeeSettlementReport Job Type

This release includes the new job type of FeeSettlementReport.

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 Bulk Data Exchange API.

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

Index of Changed Calls - 1.0.0

These calls are included in the initial release of the eBay Bulk Data Exchange 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.