The table below describes the fields in an order report. An order report is a response file. See Obtaining order reports for details.
Sample response files:
Note: The fields in the table below are ordered according to their order in the CSV order report response file. The parent is provided for XML fields in order to make it easier to locate that field in the XML order report response file.
Field name |
Description |
---|---|
CSV: XML: |
The unique identifier of the eBay order Note: The unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Occurrence: Always Returned |
CSV: XML: |
The unique identifier for a sales channel, such as Occurrence: Optional |
CSV: XML: Not returned in XML response |
The seller's unique identifier for the order. Unlike the orderID value, which is automatically created by eBay, this order identifier is created by the seller |
CSV: XML: |
Indicates the date and time that the order was created. The valid date-time format is: Occurrence: Always Returned |
CSV: XML: |
The buyer's eBay user ID Occurrence: Always Returned |
CSV: XML: |
The buyer's email address Occurrence: Always Returned |
CSV: XML: Not returned in XML response |
The buyer’s name |
CSV: XML: |
The buyer's first name Occurrence: Always Returned |
CSV: XML: |
The buyer's last name. Occurrence: Always Returned |
CSV: XML: see |
Unique identifier for a user's address in the eBay database, which can alleviate the need to store an address multiple times across multiple orders. The ID changes if a user changes their address See Shipping related fields for use |
CSV: XML: see |
The buyer's eBay user ID See Shipping related fields for use |
CSV: XML: see |
The buyer's phone number See Shipping related fields for use |
CSV: XML: see |
The buyer's shipping address See Shipping related fields for use |
CSV: XML: see |
The buyer's apartment or suite number, if needed See Shipping related fields for use |
CSV: XML: see |
The buyer's city See Shipping related fields for use |
CSV: XML: see |
The buyer's county, district, or region, if needed See Shipping related fields for use |
CSV: XML: see |
The buyer's state or province See Shipping related fields for use |
CSV: XML: see |
The buyer's postal code or region designation See Shipping related fields for use |
CSV: XML: see |
The buyer's country See Shipping related fields for use |
CSV: XML: |
The seller's eBay user ID Occurrence: Always Returned |
CSV: XML: |
Direct shipping method for getting the item to the buyer. Valid values:
Occurrence: Always Returned |
CSV: XML: Not returned in XML response |
The shipping sales channel-specific program that will be used to fulfill the order |
CSV: XML: |
The shipping sales channel-specific program that will be used to fulfill the order. Valid values:
|
CSV: XML: |
Numerical ID of the shipping service |
CSV: XML: Not returned in XML response |
This is the specific shipping that the buyer has selected. Values vary by carrier.
|
CSV: XML: |
The type of shipping method, such as |
CSV: XML: Not returned in XML response |
Identifies an order that was shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Include this value on the package above the street address of the international shipping provider |
CSV: XML: |
Unique identifier for a buyer's address in the eBay database. Using an ID is easier and faster than having to enter the whole address each time you need it, especially when the buyer laces multiple orders. The ID changes if a buyer changes their address See Shipping related fields for use |
CSV: XML: |
The name associated with the address. This is usually the buyer's name or the store's name, whichever is applicable See Shipping related fields for use |
CSV: XML: |
The phone number associated with the address See Shipping related fields for use |
CSV: XML; |
The first line of the street address, typically the number and street name See Shipping related fields for use |
CSV: XML: |
The second line of the street address, typically a suite or apartment number See Shipping related fields for use |
CSV:
|
The city in which the street address is located See Shipping related fields for use |
CSV: XML: |
The county in which the street address is located See Shipping related fields for use |
CSV: XML: |
The state or province in which the address is located See Shipping related fields for use |
CSV: XML: |
The postal (or zip) code of the address See Shipping related fields for use |
CSV: XML: |
The country in which the address is located See Shipping related fields for use |
CSV: XML: |
The estimated delivery date to the buyer. This time is calculated by adding your handling time (set up in your shipping policy) and expected shipping time of the selected shipping service to the order creation time |
CSV: XML: |
Unique identifier for a buyer's address in the eBay database, which can alleviate the need to store an address multiple times across multiple orders. The ID changes if a user changes their address See Shipping related fields for use |
CSV: XML: |
The name associated with the address. This is usually the buyer's name or the store's name, whichever is applicable See Shipping related fields for use |
CSV: XML: |
The phone number associated with the final destination address See Shipping related fields for use |
CSV: XML: |
The first line of the street address, typically the number and street name See Shipping related fields for use |
CSV: XML: |
The second line of the street address, typically a suite or apartment number See Shipping related fields for use |
CSV: XML: |
The city in which the street address is located See Shipping related fields for use |
CSV: XML: |
The county in which the street address is located See Shipping related fields for use |
CSV: XML: |
The state or province in which the address is located See Shipping related fields for use |
CSV: XML: |
The postal code of the address See Shipping related fields for use |
CSV: XML: |
The country in which the address is located See Shipping related fields for use |
CSV: XML: Not returned in XML response |
This value indicates the pickup type, such as |
CSV: XML: Not returned in XML response |
Unique identifier (defined by you) for an inventory location that is set up with the availability feed. Once established, the locationID value can’t be changed |
CSV: XML: Not returned in XML response |
The seller-defined unique identifier of the merchant's store where the item will be picked up. Only returned if defined by seller |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The name of the store where the item will be picked up |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The phone number of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The first line of the street address, typically the number and street name, of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The second line of the street address of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The city in which the street address is located of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The county in which the street address is located of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The state or province in which the address is located |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The postal (or zip) code of the address of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The country in which the address is located of the store where the item will be picked up. |
CSV: XML: Not returned in XML response |
Note: This field is used for BOPIS and Click and Collect stores. The expected time when a pickup order will be ready for pickup at the store |
CSV: XML: |
Unique identifier of the order line item that is created by eBay when the buyer commits to buy the line item Occurrence: Always Returned |
CSV: XML: |
The unique identifier for a sales channel. Values include Note: listingChannelID is the actual marketplace where the sale occurred which may or may not be the same marketplace where the seller listed the items that have orders. Occurrence: Always Returned |
CSV: XML: |
Unique identifier of the eBay listing where the line item was purchased Occurrence: Always Returned |
CSV: XML: |
Stock keeping unit (SKU) identifier for the item Occurrence: Always Returned |
CSV: XML: |
The title that appears in the listing. If a listing is on hold, the itemID of the listing is returned instead of the title. |
CSV: XML: |
Indicates the quantity of the item purchased by the buyer per order or per line item Occurrence: Always Returned |
CSV: XML: |
Used in the European Union countries to inform prospective buyers how much they are paying for the item by the weight, volume, or unit. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. The per-unit price is displayed on eBay EU sites only |
CSV: XML: |
Indicates the currency used for the unit price of the line item. Currency codes are: USD, CAD, GBP, AUD, EUR, and RUB |
CSV: XML: |
The cost type for the line item. Valid values:
CSV sample [{"pricelineType":"ITEM","amount":"13.36","currency":"USD"},{"pricelineType":"SHIPPING","amount":"0.00","currency":""},{"pricelineType":"ITEM_TAX","description":"SalesTax", "amount":"0.94","currency":"USD"}] XML sample <subtotal> <priceline type="ITEM"> <amount currencyCode="USD">49.98</amount> </priceline> <priceline type="SHIPPING"> <amount currencyCode="">0.00</amount> </priceline> <priceline type="ITEM_TAX"> <description>SalesTax</description> <amount currencyCode="USD">3.50</amount> </priceline> <sumtotal currencyCode="USD">53.48</sumtotal> </subtotal>
Occurrence: Always Returned |
CSV: XML: |
Current cost for the line item based on one or more costs/discounts shown in one or more priceLine elements/fields |
CSV: XML: |
Shows the currency used for the current cost of the line item. Currency codes are: |
CSV: XML: |
This field updates the status of the order. Valid values:
|
CSV: XML: Not returned in XML response |
This field is deprecated, and can be ignored if returned. |
CSV: XML: Not returned in XML response |
This field is deprecated, and can be ignored if returned. |
CSV: XML: Not returned in XML response |
Provides a note about the order line item |
CSV: XML: Not returned in XML response |
The name of the payment processor |
CSV: XML: |
Unique identifier for the payment, which is generated by eBay at the time of payment |
CSV: XML: Not returned in XML response |
Indicates the name of the account that the payment was applied to. Only returned if the account name is known |
CSV: XML: |
Fee Amount is a positive value and Credit Amount is a negative value. |
CSV: payment.feeOrCreditAmountCurrency XML: |
Fee Amount is a positive value and Credit Amount is a negative value. |
CSV: XML: |
Total amount paid for the order. This value is returned after the buyer has completed checkout |
CSV: XML: |
The currency used for payment of the order. Currency codes are: |
CSV: XML: |
The date and time the buyer pays for the order |
CSV: XML: |
Note: The payment method is not always exposed to seller since eBay handles payment from buyer. Payment method used for order payment. |
CSV: XML: Not returned in XML response |
This field is deprecated, and can be ignored if returned. |
CSV: XML: |
The cost type for the order. Valid values:
CSV sample [{"pricelineType":"ITEM","amount":"26.92","currency":"USD"},{"pricelineType":"ITEM_TAX","amount":"","currency":""},{"pricelineType":"SHIPPING","amount":"0.0","currency":"USD"},{"pricelineType":"DISCOUNT","amount":"0.0","currency":"USD"}] XML sample <total> <priceline type="ITEM"> <amount currencyCode="USD">9.99</amount> </priceline> <priceline type="ITEM_TAX"> <amount currencyCode=""/> </priceline> <priceline type="SHIPPING"> <amount currencyCode="USD">0.0</amount> </priceline> <priceline type="DISCOUNT"> <amount currencyCode="USD">0.0</amount> </priceline> <sumtotal currencyCode="USD">9.99</sumtotal> </total>
|
CSV:
|
The current cost for the order based on one or more costs/discounts shown in one or more priceLine elements/fields |
CSV: XML: |
The currency used for the current cost of the order. Valid currency codes:
|
CSV: XML: |
The current payment status of the order. Valid values:
|
CSV: XML: |
Updates the status of the order. Valid values:
|
CSV: XML: ShipmentTrackingDetails.ShipmentTrackingNumber
|
The tracking number of the shipment. This will be returned if available |
CSV: XML: |
Contains a note about the order |
CSV: XML: |
This field is deprecated since eBay Guaranteed Delivery is no longer a supported feature. |
CSV: XML: |
This value is the actual tax ID for the buyer. The type of tax ID is shown in the buyerTaxIdType field. |
CSV: XML: |
The country that issued the buyer's tax ID. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country. |
CSV: XML: |
This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process. See Tax ID type enumerated values for list of valid values. |
CSV: XML: |
This is the Selling Manager Sales Record Number. |
CSV: XML: |
The payment method that the buyer selected to pay for the order. Note: The PaymentMethod field is not always exposed to the seller since eBay handles payment from the buyer. And if a payment method is returned, it may not be accurate. |
CSV: XML: |
This field is deprecated, and can be ignored if returned |
CSV: XML: |
eBay is required to collect and remit the taxes directly from the buyers in certain situations. eBay is responsible for collecting and remitting internet sales tax (IST) for many US states and also collects and remits goods and services taxes (GST) for many items that ship to Australia and New Zealand. When eBay collects taxes from the buyer, the collected tax container will include:
CSV sample [{"imposition":"SalesTax","description":"SalesTax", "amount":"0.94", "currency":"USD","collectionMethod":"NET", "TotalIncludesEBayCollectedTax":"true"}] XML sample <eBayCollectedTax> <eBayReference name="IOSS"> IM2****00742 </eBayReference> <taxDetails> <imposition>SalesTax</imposition> <description>SalesTax</description> <amount currencyCode="USD">0.74</amount> <collectionMethod>NET</collectionMethod> </taxDetails> <totalIncludesEBayCollectedTax>false</totalIncludesEBayCollectedTax> </eBayCollectedTax>
|
CSV: XML: |
The VAT ID for eBay, returned if VAT tax is applicable for the order. This value may vary based on the region or country. The eBayReference contains a name attribute which indicates the type of VAT ID. This string value will be one of the following:
|
CSV: XML: |
eBayCollectedTax reference ID |
CSV: XML: |
Note: Information is only returned in this field if the corresponding order has one or more linked line items; otherwise null (empty). CSV always returns this column with either information in JSON format or null. XML only returns information if the corresponding order has one or more linked line items, otherwise the entire container is not returned. If the order has one or more linked line items, this field contains
See Separate orders can be linked for use and the following examples for the expected structure, name/value pairs, and delimiters (CSV). CSV sample {"orderID":"02-00049-10334","orderLineItemID":"120031143647-15998937002","sellerUserID":"pna_seller_us","title":"Tires Category_179680_ZIP-95125_LotSize-1-rim-16-96464_US","estimatedDeliveryTimeMin":"2023-08-02T07:00:00.842Z","estimatedDeliveryTimeMax":"2023-08-09T07:00:00.842Z","itemSpecifics":[\{"Name":"Manufacturer Part Number","Value":"Does Not Apply"},{"Name":"Tire Type","Value":"All Season"},{"Name":"Overall Diameter","Value":"20"},{"Name":"UPC","Value":"Does not apply"},{"Name":"Quantity","Value":"1"},{"Name":"Section Width","Value":"8"},{"Name":"Rim Diameter","Value":"16"},{"Name":"Aspect Ratio","Value":"30"},{"Name":"Brand","Value":"American"},{"Name":"Load Index","Value":"63"},{"Name":"Car Type","Value":"Passenger/Performance"},{"Name":"Speed Index","Value":"J"},{"Name":"Tire Sizing System","Value":"Passenger"}]} XML sample <linkedLineItem> <orderID>2*-*****-****3</orderID> <orderLineItemID>12*********7-1*********2</orderLineItemID> <sellerUserID>p***********s</sellerUserID> <title> Tires Category_179680_ZIP-95125_LotSize-1-rim-16-96464_US </title> <estimatedDeliveryTimeMin> 2023-09-06T07:00:00.328Z </estimatedDeliveryTimeMin> <estimatedDeliveryTimeMax> 2023-09-09T07:00:00.328Z </estimatedDeliveryTimeMax> <itemSpecifics> <name>Manufacturer Part Number</name> <value>Does Not Apply</value> </itemSpecifics> <itemSpecifics> <name>Tire Type</name> <value>All Season</value> </itemSpecifics> <itemSpecifics> <name>Overall Diameter</name> <value>20</value> </itemSpecifics> <itemSpecifics> <name>UPC</name> <value>Does not apply</value> </itemSpecifics> <itemSpecifics> <name>Quantity</name> <value>1</value> </itemSpecifics> <itemSpecifics> <name>Section Width</name> <value>8</value> </itemSpecifics> <itemSpecifics> <name>Rim Diameter</name> <value>16</value> </itemSpecifics> <itemSpecifics> <name>Aspect Ratio</name> <value>30</value> </itemSpecifics> <itemSpecifics> <name>Brand</name> <value>American</value> </itemSpecifics> <itemSpecifics> <name>Load Index</name> <value>63</value> </itemSpecifics> <itemSpecifics> <name>Car Type</name> <value>Passenger/Performance</value> </itemSpecifics> <itemSpecifics> <name>Speed Index</name> <value>J</value> </itemSpecifics> <itemSpecifics> <name>Tire Sizing System</name> <value>Passenger</value> </itemSpecifics> </linkedLineItem>
|
Shipping fields
Use of the shipping fields is different for CSV and XML.
CSV address-related fields
For direct shipping: The buyerAddressID through buyerCountry fields (including the associated columns between), are returned for direct shipping to the buyer.
Note: The seller ships the item to the shipToAddressID address in the case of multi-leg shipments, and a third party partner is responsible for shipping to final destination (finalDestinationAddressID, finalDestinationAddressName, finalDestinationAddressPhone, and related columns).
For multi-leg shipping: The shipToAddressID through shipToCountry fields, and finalDestinationAddressID through finalDestinationCountry fields, are returned for multi-leg shipments. For these multi-leg shipments, the shipTo fields are associated with first leg, and the finalDestination fields are associated with final leg.
XML address-related fields
For direct shipping: The shipToAddress container is returned consisting of fields for direct shipping to the buyer.
Note: The seller ships the item to the shipToAddress container's address in the case of multi-leg shipments, and a third party partner is responsible for shipping to final destination (finalDestinationAddress container).
For multi-leg shipping: The shipToAddress container, and the finalDestinationAddress container are returned for multi-leg shipments. For these multi-leg shipments, the shipToAddress container is associated with first leg, and the finalDestinationAddress container is associated with the final leg.
Separate orders can be linked
Limited information from separate linked orders, which may be from different sellers, can be returned through the order report. The information can provide details about a component (purchased from one seller) needed for its installation (purchased from a different seller). Details can identify the linked seller and also include delivery times, item information, and order information.
For example, if a tire order is linked to a separate order for installation, limited information about the tire order is available in the installation order:
-
order number
-
shipping information (including shipping service*, estimated ship date)
-
tire seller name, tire listing title, and tire specifications including (wheel diameter, aspect ratio, section width, and other similar aspects)
-
buyer email and phone number (this can help with scheduling appointments)*
* These fields, if available, appear in other areas of the order report (not in linkedLineItem). For a example, shipping service would be found under shippingServiceName for CSV, and logisticsPlan.shipping.shippingService for XML.