Response fields
Response field descriptions
Output container/field | Type | Description |
---|---|---|
itemId | string | The unique identifier of the listing in eBay RESTful format. For a single-variation listing, an example would be Occurrence: Always |
title | string | 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. Occurrence: Always |
description | string | The listing description. 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. Occurrence: Always |
imageUrl | string | A list of URLs to all images that are defined for the listing. Occurrence: Always |
itemWebUrl | string | The URL of the View Item page of the listing or item variation within the listing. Occurrence: Always |
availability | AvailabilityEnum | 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 |
condition | string | 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: Always |
priceValue | string | The price of the item. Occurrence: Always |
priceCurrency | CurrencyCodeEnum | 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 |
gtin | string | 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 |
mpn | string | This value is the Manufacturer Part Number (MPN). An MPN value must always be paired with a brand value to make it a valid identifier. So, if a product has an MPN value, the brand value should also be referenced. Occurrence: Conditional |
brand | string | 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 |
defaultImageUrl | string | The URL of the gallery image. Occurrence: Always |
ageGroup | string | 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 |
color | string | 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 |
gender | string | 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 |
material | string | 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 |
categoryId | string | The unique identifier of the listing category. Occurrence: Always |
category | string | The name of the listing category. Occurrence: Always |
epid | string | This value is the eBay Product Identifier (ePID). Each eBay catalog product has a unique ePID value. Occurrence: Always |
unitPricingMeasure | string | 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 |
totalUnits | string | 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 Occurrence: Conditional |
unitPrice | string | This field shows the price per weight, per volume, or per count of the item. For this value to mean something, the user must also look at the unitPricingMeasure field, which will show the weight/volume/count measurement unit such as 100 ml. So, if the unitPrice value is 6.8 EUR, the unitPricingMeasure value is 100 ml, 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 |
handlingTime | integer | 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 Occurrence: Conditional |
minEstimatedDeliveryDays | integer | 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 |
maxEstimatedDeliveryDays | integer | 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 |
returnsAccepted | boolean | A value of Occurrence: Always |
returnPeriodValue | integer | The number of days that the buyer has to return the item after the purchase date. For example, if this value is Occurrence: Conditional |
freeReturn | boolean | A value of Occurrence: Always |
qualifiedPrograms | string | A pipe separated list of eBay programs that the listing qualifies for, such as Occurrence: Conditional |
sellerTrustLevel | SellerTrustLevelEnum | 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 |
shippingCost | string | 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. Occurrence: Conditional |