Order feed definitions

This table provides field definitions to help you understand the order feed.

Field Name	Description	Example	Use
buyer AddressID	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.	TomJones	Optional
buyer AddressLine1	Buyer's shipping address. Only applicable if the seller is shipping the order to the buyer's address.	16239 Long Branch Road	Conditional
buyer AddressLine2	Buyer's apartment or suite number, if needed.	Suite C	Conditional
buyerCity	Buyer's city.	Los Gatos	Conditional
buyerCountry	Buyer's country.	US	Conditional
buyerCounty	Buyer's county, district, or region, if needed.	Santa Cruz	Optional
buyerEmail	Buyer's email address. 11	writethem@gmail.com	Always
buyerFirstName	Buyer's first name.	Tom	Always
buyerID	Buyer's eBay user ID, first name, last name, or all 3.	IbuyBig	Optional
buyerLastName	Buyer's last name.	Jones	Always
buyerName	Buyer's eBay user ID.	IbuyBig	Optional
buyerName OnAddress	Buyer's eBay user ID.	IbuyBig	Optional
buyerPhone	Buyer's phone number.	4085551432	Optional
buyerPostalCode	Buyer's postal code or region designation.	95033	Conditional
buyerStateOr Province	Buyer's state or province	California.	Conditional
channellD	The unique identifier for a sales channel, such as EBAY_US. Other valid values include: EBAY_AT, EBAY_AU, EBAY_CA, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_IN, EBAY_IT, EBAY_RU, or EBAY_UK.	EBAY_DE	Optional
createdDate	Indicates the date and time that the order was created. Use this date-time format: YYYY-MM-DDTHH:MM:SS	2014-08-04T19:09:02.768Z	Always
expectedDelivery Date	Indicates 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.	2014-08-05T19:09:02.768Z	Conditional
expectedPickup Time	Indicates the estimated time the order is expected to be ready for the buyer or an eBay Now courier to pick up the order. This time is calculated by adding the fulfillment time (set in the availability feed, or defaulting to the default value set up in your eBay account) to the order creation time.	2014-08-05T19:09:02.768Z	Conditional
finalDestination AddressID	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.	TomJones	Conditional
finalDestination AddressLine1	The first line of the street address, typically the number and street name.	16239 Long Branch Road	Conditional
finalDestination AddressLine2	The second line of the street address, typically a suite or apartment number	Suite C	Conditional
finalDestination City	The city in which the street address is located.	Los Gatos	Conditional
finalDestination Country	The country in which the address is located.	US	Conditional
finalDestination County	The county in which the street address is located.	Santa Cruz	Conditional
finalDestination AddressName	The name associated with the address. This is usually the buyer's name or the store's name, whichever is applicable.	IbuyBig	Conditional
finalDestination AddressPhone	The phone number associated with the address.	4085551432	Conditional
finalDestination PostalCode	The postal (or zip) code of the address.	95033	Conditional
finalDestination StateOrProvince	The state or province in which the address is located.	California.	Conditional
fulfillmentType	Method for getting the item to the buyer. Valid values include SHIP_TO_HOME and PICKUP_IN_STORE, and the latter requires using the pickupInStoreEligible in the distribution feed.	PICKUP_IN_STORE	Always
giftMessage	If a gift message was available to and provided by the buyer, this field will contain the text that comprises the message.	To my dearest Diana, Happy Birthday.	Conditional
giftWrap	If gift wrapping services were available to and purchased by the buyer, this field will be returned as true.	true	Conditional
itemID	Unique identifier of the eBay listing where the line item was purchased	271673602178	Always
lineItemID	Unique identifier of the order line item that is created by eBay when the buyer commits to buy the line item.	303455279829 - 303455640014	Always
lineItemNote	Provides a note about the order line item.	Product had to be shipped in separate packages.	Conditional
lineItemPriceLines	Identifies the cost type for the line item. The following values are supported: ITEM: Indicates that the dollar value in the amount field is the cost of the line item. This value is similar to LINE_ITEM_SUBTOTAL, but ITEM is returned for single-line item orders, and LINE_ITEM_SUBTOTAL is returned for multiple line item orders. TAX: Indicates that the dollar value in the amount field is the sales tax applied to the line item. SHIPPING: Indicates that the dollar value in the amount field is the shipping cost of the line item. DISCOUNT: Indicates that the dollar value in the amount field is the discount to the line item. Should be a negative value. RECYCLING: Indicates that the dollar value in the amount field is the recycling fee associated with the line item. LINE_ITEM_SUBTOTAL: Indicates that the dollar value in the amount field is the cost of the line item. This value is similar to ITEM, but LINE_ITEM_SUBTOTAL for multiple line item orders, and ITEM for item orders.	DISCOUNT: -2.00	Always
lineItemSumTotal	Current cost for the line item based on one or more costs/discounts shown in one or more priceLine elements/fields.	27.50	Conditional
lineItemSum TotalCurrency	Shows the currency used for the current cost of the line item. Currency codes are: USD, CAD, GBP, AUD, EUR, and RUB.	USD	Conditional
listingChannelID	The unique identifier for a sales channel, such as EBAY_US. Other valid values include: EBAY_AT, EBAY_AU, EBAY_CA, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_IN, EBAY_IT, EBAY_RU, or EBAY_UK. Always returned to identify the sales channel on which the listing was created.	EBAY_DE	Always
logisticsStatus	This field to update the status of the order. The valid values include: PICKED_UP: Indicates that the buyer has picked up an In-Store Pickup order. This is typically a status update that you send for eBay's records. READY_FOR_PICKUP: Indicates that the In-Store Pickup order is ready to be picked up by the buyer. SHIPPED: Indicates that the order has been shipped. This is typically the value that is used when the seller is providing the buyer with shipment tracking information.	READY_FOR_PICKUP	Conditional
merchantOrderID	Your unique identifier for the order. This order identifier is created by you, unlike the orderID value, which is automatically created by eBay.	276458	Optional
multiLegShipping ReferenceID	Identifies an order 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	Reference #1234567890123456	Conditional
note	Displays a note about the order.	Large parcel.	Conditional
orderID	Unique identifier of the eBay order.	81473577010	Always
orderLogistics Status	This field to update the status of the order. The valid values include: PICKED_UP: Indicates that the buyer has picked up an In-Store Pickup order. This is typically a status update that you send for eBay's records. READY_FOR_PICKUP: Indicates that the In-Store Pickup order is ready to be picked up by the buyer. SHIPPED: Indicates that the order has been shipped. This is typically the value that is used when the seller is providing the buyer with shipment tracking information.	READY_FOR_PICKUP	Conditional
orderPayment Status	Provides the current payment status of the order. Valid values include: FAILED: Indicates that the buyer attempted to pay for the order but the payment wasn’t processed successfully. PAID: Indicates that the buyer has paid the entire balance for the order. PARTIALLY_PAID: Indicates that the buyer has paid for a portion of the order, but there’s still an unpaid balance. PENDING: Indicates that payment has been initiated by the buyer, but the payment hasn’t yet cleared. UNPAID: Indicates that the buyer has yet to pay for the order.	PAID	Conditional
orderPriceLines	Identifies the cost type for the line item. The following values are supported: ITEM: Indicates that the dollar value in the amount field is the cost of the line item. This value is similar to LINE_ITEM_SUBTOTAL, but ITEM is returned for single-line item orders, and LINE_ITEM_SUBTOTAL is returned for multiple line item orders. TAX: Indicates that the dollar value in the amount field is the sales tax applied to the line item. SHIPPING: Indicates that the dollar value in the amount field is the shipping cost of the line item. DISCOUNT: Indicates that the dollar value in the amount field is the discount to the line item. Should be a negative value. RECYCLING: Indicates that the dollar value in the amount field is the recycling fee associated with the line item. LINE_ITEM_SUBTOTAL: Indicates that the dollar value in the amount field is the cost of the line item. This value is similar to ITEM, but LINE_ITEM_SUBTOTAL for multiple line item orders, and ITEM for item orders.	DISCOUNT: -2.00	Conditional
orderSumTotal	The current cost for the order based on one or more costs/discounts shown in one or more priceLine elements/fields.	22.00	Conditional
orderSumTotal Currency	Shows the currency used for the current cost of the order. Currency codes are: USD, CAD, GBP, AUD, EUR, and RUB.	USD	Conditional
paidToAccount	Indicates the name of the account that the payment was applied to. Only returned if the account name is known.	PayPal	Conditional
payment ClearedDate	The date and time the buyer pays for the order.	2014-08-04T19:09:02.768Z	Conditional
paymentCurrency	The currency used for payment of the order. Currency codes are: USD, CAD, GBP, AUD, EUR, and RUB.	USD	Conditional
paymentID	Unique identifier for the payment, which is generated by eBay at the time of payment.	7234276458	Conditional
payment ProcessedBy	The name of the payment processor, like PayPal if PayPal is the payment method.	PayPal	Conditional
paymentTotal	Total amount paid for the order. This value is returned after the buyer has completed checkout.	57.95	Conditional
pickupAddress City	The city in which the street address is located.	Los Gatos	Conditional
pickupAddress Country	The country in which the address is located.	US	Conditional
pickupAddress County	The county in which the street address is located.	Santa Cruz	Conditional
pickupAddressID	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.	TomJones	Conditional
pickup AddressLine1	The first line of the street address, typically the number and street name.	16239 Long Branch Road	Conditional
pickup AddressLine2	The second line of the street address, typically a suite or apartment number	Suite C	Conditional
pickup AddressName	The name associated with the address. This is usually the buyer's name or the store's name, whichever is applicable.	IbuyBig	Conditional
pickupAddress Phone	The phone number associated with the address.	4085551432.	Conditional
pickupAddress PostalCode	T The postal (or zip) code of the address.	95033	Conditional
pickupAddress StateOrProvince	The state or province in which the address is located.	California.	Conditional
pickupLocationID	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.	San Jose Store	Conditional
pickupType	Indicates whether the order is an eBay Now order or an In-Store Pickup order. This attribute's value will be RECIPIENT for an In-Store Pickup order, or the value will be COURIER, meaning that an eBay Now courier will pick up the order at the store for local delivery to the buyer.	RECIPIENT	Conditional
programType	Indicates the sales channel-specific program that will be used to fulfill the order.	Promotion	Conditional
quantity	Indicates the quantity of the item purchased by the buyer per order or per line item.	2	Always
sellerID	Your eBay user ID.	BestProductsEver	Always
shippingMethod	Type of the shipping service.	Large Envelope	Conditional
shippingServiceID	Numerical ID of the shipping service.	UPS876678	Conditional
shippingService Name	Name of the shipping service.	UPS	Conditional
shippingType	Type of the shipping service.	UPS Overnight	Conditional
shipToAddress City	The city in which the street address is located.	Los Gatos	Conditional
shipToAddress Country	The country in which the address is located.	US	Conditional
shipToAddress County	The county in which the street address is located.	Santa Cruz	Conditional
shipToAddressID	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.	TomJones	Conditional
shipTo AddressLine1	The first line of the street address, typically the number and street name.	16239 Long Branch Road	Conditional
shipTo AddressLine2	The second line of the street address, typically a suite or apartment number	Suite C	Conditional
shipToAddressName	The name associated with the address. This is usually the buyer's name or the store's name, whichever is applicable.	IbuyBig	Conditional
shipToAddressPhone	The phone number associated with the address.	4085551432	Conditional
shipToAddress PostalCode	The postal (or zip) code of the address.	95033	Conditional
shipToAddress StateOrProvince	The state or province in which the address is located.	California.	Conditional
SKU	Stock keeping unit (SKU) identifier for the item.	134380234BDX	Always
title	The title that appears in the listing.	Black & Decker Turbocharged Lawn Mower	Conditional
unitPrice	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.	4,00	Conditional
unitPriceCurrency	Indicates the currency used for the unit price of the line item. Currency codes are: USD, CAD, GBP, AUD, EUR, and RUB.	EUR	Conditional