Sellers upload XML data files, with various Merchant Data objects using the Sell Feed API with LMS feed types, to define the data sent to eBay for processing. Different feed types are used to perform different actions.
Feed types can:
Add, revise, relist, verify, or end listings in bulk by uploading a file through the Inventory upload feed types flow
LMS_ORDER_ACKfeed type (OrderAck) can acknowledge an entire order (with single or multiple line items) or it can acknowledge a single line item within an order. This feed type can acknowledge that an order, or orders, has been received and remove the order from the order report. Using the same type of flow, the
LMS_SET_SHIPMENT_TRACKING_INFOfeed type (SetShipmentTrackingInfo) can specify the shipment tracking information associated with one or more packages of an order, or mark an order as paid or shipped. These are tasks are completed by uploading a file through the Fulfillment upload feed types flow.
Download an Order Report or an Active Inventory Report through the Report download feed types flow. Users can set up the filter criteria that is used to generate the report
Note: There are no feed types that support FeeSettlementReport. Use the Finances API as an alternative to get fee-related information. Similarly, there are no feed types that support UploadSiteHostedPictures. Use the UploadSiteHostedPictures of the Trading API to upload pictures.
Important! Make sure to use the applicable feed type and "create task" method to use when creating the task. For example, when creating an AddFixedPriceItemRequest task, call the createTask method using the
LMS_ADD_FIXED_PRICE_ITEM feed type; when creating an ActiveInventoryReport task, call the createInventoryTask method using the
LMS_ACTIVE_INVENTORY_REPORT feed type.
Note: The requests and responses described in the Merchant Data API Reference are for constructing data files to be uploaded and parsing downloaded data files only.
A data file contains the seller's requests to eBay and also eBay's responses and reports. The data request file contains the seller's requests to eBay, and the data response file contains eBay's responses and reports. Examples of the seller's requests include AddFixedPriceItemRequest, ReviseFixedPriceItemRequest, or OrderAck. Examples of eBay's responses and reports include ActiveInventoryReport or OrderReport (report types do not use “Response” in their response files).
Each data file has a consistent structure:
Requests or Responses container
Note: All request types submitted in a payload must be the same. This means that you cannot mix AddFixedPriceItem requests with ReviseFixedPriceItem requests within a given data file.
For example, the following illustrates a seller's ReviseFixedPriceItemRequest data file:
As an example of a report, the following illustrates a seller's active inventory report response (ActiveInventoryReport) containing two SKUs:
Note: Most LMS feed type calls, including OrderAck and SetShipmentTrackingInfo use “Request” in their payloads (
SetShipmentTrackingInfoRequest, respectively), and "Response" in their response (
SetShipmentTrackingInfoResponse). The two report types do not use “Response” in their response files, but just the
For Requests, include an XML declaration with the encoding attribute set to UTF-8. Responses also include an XML declaration.
Requests or Responses container
A data file contains one BulkDataExchangeRequests node (a Requests container) or one BulkDataExchangeResponses node (a Responses container).
BulkDataExchangeRequests—The Requests container contains the Payload. When creating the request data file, include a single BulkDataExchangeRequests node with a Payload consisting of one or more requests.
BulkDataExchangeResponses—The payload of a downloaded data file is contained in a BulkDataExchangeResponses node. The response container also includes a namespace declaration. A single BulkDataExchangeResponses node contains the response.
The data file payload consists of one or more requests, responses, or a report. An ActiveInventoryReport will have information on multiple listings and an OrderReport will have information on multiple orders. The Merchant Data API Reference describes the input fields for requests and the output fields for responses and reports. All request types submitted in a payload must be the same. This means that you cannot mix AddFixedPriceItem requests with ReviseFixedPriceItem requests within a given data file.
Refer to Creating the data file in Working with the Sell Feed API using LMS feed types for more information about creating data files.
You can use the Merchant Data XSD to generate stub code or validate your payloads. For the most up-to-date file available, use the Latest Merchant Data XSD. Older versions of the XSD are also available. The versions of the the XSD are located in
/webservices/<version_no> directory. For example, version 1247 is available at /webservices/1247/merchantdataservice.xsd.