Skip to main content

Response fields

Response field descriptions

Output container/fieldTypeDescription
itemLocationCountrystring

The country where the item is physically located.

Occurrence: Conditional

buyingOptionsstring

A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE. Note that auction listings may be included in a Buy Feed file, but only if the 'Buy It Now' option is available for that auction listing.

Occurrence: Always

priceCurrencyCurrencyCodeEnum

The currency used for the price of the item. Generally, this is the currency used by the country of the eBay marketplace offering the item.

Occurrence: Always

priceValuestring

The price of the item.

Occurrence: Always

imageUrlstring

A list of URLs to all images that are defined for the listing.

Occurrence: Always

itemAffiliateWebUrlstring

The URL of the View Item page of the item, with the affiliate tracking ID appended to it.

Example:https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=7**-5***7-1*****0&campid=CAMPAIGNID&toolid=2***6&customid=C******D

Occurrence: Conditional

categoryIdstring

The unique identifier of the listing category.

Occurrence: Always

categorystring

The name of the listing category.

Occurrence: Always

marketplaceIdstring

The unique identifier of the eBay marketplace. See this page for the full list of can be found here eBay marketplace IDs.

Occurrence: Always

itemIdstring

The unique identifier of the listing in eBay RESTful format. For a single-variation listing, an example would be v1|1**********2|0. For a multiple-variation listing, an example would be v1|1**********2|4**********2, with the first set of numbers identifying the listing, and the second set of numbers identifying a specific variation within that listing.

Occurrence: Always

itemCreationDatenumber

A timestamp indicating when the listing was created. UTC timestamps are used and have the following format: yyyy-MM-ddThh:mm:ss.sssZ.

Occurrence: Always

itemEndDatenumber

A timestamp indicating when the item's sale period will end based on its start date and duration. UTC timestamps are used and have the following format: yyyy-MM-ddThh:mm:ss.sssZ.

Occurrence: Conditional

titlestring

The title of the listing. This title can be created by the seller, or it may be the title used by an eBay catalog product if the seller listed the product based off of an eBay catalog product.

Note that if a listing title has special characters in it, such as double quote marks, you may see a backslash character to escape these special characters.

Max length: 80 characters (not including escape characters).

Occurrence: Always

shippingCoststring

The cost to ship the item using the cheapest shipping service option available for the item. Unless the seller uses flat-rate shipping and charges the same price to ship the item to all locations where he/she is willing to ship, the actual shipping cost will vary based on where the buyer is located.

Some sellers will offer a free shipping option, and if that is the case, the value returned here will be 0.0.

Occurrence: Conditional

defaultImageUrlstring

The URL of the gallery image.

Occurrence: Always

availabilityAvailabilityEnum

This enumeration value will indicate whether quantity of the item is still available for purchase. See the AvailabilityEnum type description for more information on what each value indicates.

Occurrence: Always

colorstring

The color of the item. A value for this field will only be returned if 'Color' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

sizestring

The size of the item. A value for this field will only be returned if 'Size' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

genderstring

The specified gender that the item is intended for. A value for this field will only be returned if 'Gender' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

brandstring

The brand of the product. A value for this field will only be returned if 'Brand' is a defined item specific for the listing.

Occurrence: Conditional

materialstring

The material used for the product. A value for this field will only be returned if 'Material' is a defined item specific for the listing.

Occurrence: Conditional

sellerTrustLevelSellerTrustLevelEnum

This enumeration value indicates the trust level rating of the seller. An empty value in this field may indicate that the eBay marketplace does not use these seller trust levels, or that the seller has a different rating other than the ones defined in the SellerTrustLevelEnum type.

Occurrence: Conditional

ageGroupstring

The age group(s) that the product is intended for. A value for this field will only be returned if age/age level/age range/age group is a defined item specific for the listing. The item specifics in the actual listing will most likely use age values/ranges, but the Buy Feed API maps these age values/ranges to the following values: newborn, infant, toddler, kids, or adult.

Occurrence: Conditional

gtinstring

The unique Global Trade Item Number of the item. This can be a UPC (Universal Product Code) value, an EAN (European Article Number) value, or an ISBN (International Standard Book Number) value.

Occurrence: Conditional

sellerUsernamestring

The eBay user ID of the seller.

Occurrence: Always

descriptionstring

The listing descripton. This description can be created by the seller, or it may be the description used by an eBay catalog product if the seller listed the product based off of an eBay catalog product.

Unlike some other APIs like the GetItem call in the Trading API, the description returned in this field is only text (no HTML or CSS markup), and is limited to 1024 characters. A listing description that is longer than 1024 characters will be truncated.

Max length: 1024 characters

Occurrence: Always

originalPriceValuestring

This is the item's original price (a price that is displayed as struck-through in a View Item page). This field is only applicable to and returned when a seller uses the Strike Through Price (STP) feature for a listing. The actual price (aka 'discounted' price) can be seen in the priceValue field, and the currency used for this field and the priceValue field is shown in the priceCurrency field.

Occurrence: Conditional

energyEfficiencyClassstring

This field shows the European energy efficiency rating (EEK) of the item. Data is returned in this column only if the seller specified the energy efficiency rating for the item.

The class ratings range from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.

To retrieve the manufacturer's specifications for an item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field.

Occurrence: Conditional

totalUnitsstring

For an item that is priced by weight or length, this field shows the total number of units that are sale for one quantity of the item. For example, if the item is priced by weight, this field might show a value of 1.0 and the unitType field might show a value of POUND, meaning one quanity of the item has a weight of 1 pound. If the item is priced by length, this field might show a value of 1.0 and the unitType field might show FOOT, meaning one quanity of the item has a length of 1 foot.

Occurrence: Conditional

unitTypestring

This value will either by a length or weight measurement, and it is only applicable for an item that is priced by length or weight. Length units include FEET, INCH, METER, and CENTIMETER, and weight units include POUND, OUNCE, KILOGRAM, or GRAM.

If the item is priced by weight, this field might show a value of POUND and the totalUnits field might show a value of 1.0, meaning one quanity of the item has a weight of 1 pound. If the item is priced by length, this field might show a value of FOOT and the totalUnits field might show a value of 1.0, meaning one quanity of the item has a length of 1 foot.

Occurrence: Conditional

shipToIncludedRegionsstring

A pipe (|) separated list of two-digit country codes (defined in ISO-3166) where an item can be shipped.

Occurrence: Conditional

commissionableboolean

This value of this field is returned as true if the listing is eligible for affiliate tracking commissions, and false if the listing is not eligible for affiliate tracking commissions.

Occurrence: Always

qualifiedProgramsstring

A pipe separated list of eBay programs that the listing qualifies for, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE.

eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping and free returns on selected items. eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.

The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as luxury watches, collectible sneakers, or high-end handbags.

Occurrence: Conditional

unitPricingMeasurestring

This field shows the measurement used for unit pricing. In unit pricing, the unit price per weight, per volume, or per count is shown. An example would be 100 ml. And for this value to mean something, the user must also look at the unitPrice field, which will show the price per 100 ml. So, if the unitPrice value is 6.8 EUR, the unit price will be 6.8 EUR per 100 ml. This field is only applicable for eBay marketplaces and categories that support unit pricing. This feature helps buyers compare prices across products/brands.

Occurrence: Conditional

handlingTimeinteger

This integer value states the seller's handling time in number of business days. The seller is expected to physically ship the item within the handling time window, and the 'clock' starts as soon as the buyer pays for the item. For example, if the buyer pays for the item during the seller's business hours on a Wednesday, and the handlingTime is 1, the seller will be expected to ship the item on Thursday (the next day). Supported handling times will vary by eBay categories, but in most cases, Top Rated Sellers are expected to set a handling time of 0 or 1. If the handling time is set to 0, this indicates that the seller supports 'same-day shipping', but the buyer must complete the purchase of the item before the seller's stated same-day shipping cutoff time in order for the item to be shipped out on the same day as purchase.

Occurrence: Conditional

minEstimatedDeliveryDaysinteger

The shortest expected delivery time (in business days after payment) that the buyer can expect delivery of the item. This value is calculated by adding together the seller's handling time and the lower threshold value of the fastest shipping service option available for the listing.

Occurrence: Conditional

maxEstimatedDeliveryDaysinteger

The longest expected delivery time (in business days after payment) that the buyer can expect delivery of the item. This value is calculated by adding together the seller's handling time and the higher threshold value of the slowest shipping service option available for the listing.

Occurrence: Conditional

returnsAcceptedboolean

A value of true here indicates that returns are accepted for the item, and a value of false here indicates that the seller does not accept returns for the item. Please note that a seller must accept a return in the case of an item that a buyer marks as 'not as described' in the listing.

Occurrence: Always

returnPeriodValueinteger

The number of days that the buyer has to return the item after the purchase date. For example, if this value is 30, the buyer has 30 days to return the item for a refund. Return periods can vary by eBay marketplace and listing category, but typical return periods are 30 and 60 days.

A value should always be returned for this field if returns are accepted for the item, but will be returned empty if the seller does not accept (buyer remorse) returns.

Occurrence: Conditional

freeReturnboolean

A value of true here indicates that an item can be returned to the seller free of charge (seller pays for return shipping label), and a value of false here indicates that the buyer is responsible for return shipping charges (except in the case of 'significantly not as described' item).

Occurrence: Always

itemWebUrlstring

The URL of the View Item page of the listing or item variation within the listing.

Occurrence: Always

energyEfficiencyRangestring

A range of European energy efficiency ratings (EEK) for the item. Values can range between A and G , where A is the most energy efficient and G is the least efficient. This can be a single rating (e.g., B) or a span of ratings (e.g,. C-F). This rating helps buyers choose among various models.

Occurrence: Conditional

priorityListingPayloadstring

EPN (eBay Partner Network) publishers append this value to their affiliate tracking URL when using an EPN tracking link to track changes that occur to Priority Listing items. This field will be returned as null if the value of the priorityListing field is returned as false.

Occurrence: Conditional

trkparmsstring

Unique identifier used for EPN (eBay Partner Network) priority listings. This ID may or may not be included as part of the priorityListingPayload field.

Occurrence: Conditional

priorityListingboolean

A value of true here indicates that the listing is a Priority Listing, and a value of false here indicates that the listing is not a Priority Listing,

Occurrence: Always

conditionstring

Text describing the condition of the item. For a list of item condition values (and their numeric IDs), see the Item Condition IDs and Names page.

Occurrence: Conditional

manufacturerstring

The manufacturer of the product. A value for this field will only be returned if 'Manufacturer' is a defined item specific for the listing.

Occurrence: Conditional