The type that defines the columns returned in the Item feed file.
Type that uses Item
Call that uses Item
Fields
v1|1**********2|4**********2
.- Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character
- If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes.
For example
Before:
Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking
Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series
After:
"Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\ Tracking"
"Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series"
158671
.FIXED_PRICE
.Code so that your app gracefully handles any future changes to this list.
Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.SELLER_DEFINED_VARIATIONS
, indicates that the item group was created by the seller. Code so that your app gracefully handles any future changes to this list.
Format: UTC
yyyy-MM-ddThh:mm:ss.sssZ
- Seller changes, such as changing the title
- eBay system changes, such as changing the quantity when an item is purchased
Example without Label
Encoded Format:
encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue
Encoded Example (The delimiters are emphasized):
U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw==
Decoded:
Size:XL;Color:Red;Sleeves:Long
Example with Label
Encoded Format:
encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel|
Encoded Example (The delimiters are emphasized):
UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc=
Decoded:
Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7
Note: The separators ( | : ;
) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string.
For more information, see Encoded Aspects in the Buying Integration Guide.
Valid Values:
TOP_RATED
, ABOVE_STANDARD
, or an empty value. An empty value indicates a return of anything other than
TOP_RATED
or ABOVE_STANDARD
.Code so that your app gracefully handles any future changes to this list.
Values:
- AVAILABLE
- TEMPORARILY_UNAVAILABLE
- UNAVAILABLE
true
, you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only.
MORE_THAN
. This indicates that the seller has more than the 'Display Item Quantity', which is 10, in stock for this item. The following are the Display Item Quantity preferences the seller can set.
- Display "More than 10 available" in your listing (if applicable)
If the seller enables this preference, this column will have a value as long as there are more than 10 of this item in inventory. If the quantity is equal to 10 or drops below 10, this column will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column. - Display the exact quantity in your items
If the seller enables this preference, the availabilityThresholdType and availabilityThreshold columns will be null and the estimated quantity of the item is returned in the estimatedAvailableQuantity column.
Note: Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity.
Code so that your app gracefully handles any future changes to these preferences.
Code so that your app gracefully handles any future changes to this value.
TimeDurationUnitEnum is a common type shared by multiple eBay APIs and fields to express the time unit, but for return period duration, this value will always be
DAY
.Code so that your app gracefully handles any future changes to this list.
Valid Values:
BUYER
or SELLER
Code so that your app gracefully handles any future changes to this list.
Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, and PICKUP_DROP_OFF.
Code so that your app gracefully handles any future changes to this list.
|
) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship.
The COUNTRY: list is separated from the REGION: list with a semicolon (
;
). Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
Country Values: The two-letter ISO 3166 standard code of the country.
Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
Code so that your app gracefully handles any future changes to this list.
|
) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (
;
). Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
Country Values: The two-letter ISO 3166 standard code of the country.
Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
Code so that your app gracefully handles any future changes to this list.
If the seller actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.
If the seller provided a GTIN for the item, the seller's value is returned in the gtin column.
If the seller provided a brand for the item, the seller's value is returned in the brand column.
If the seller provided a MPN for the item, the seller's value is returned in the mpn column.
The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;).
Example without Label
Encoded Format:
encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue
Encoded Example (The delimiters are emphasized):
U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw==
Decoded:
Size:XL;Color:Red;Sleeves:Long
Example with Label
Encoded Format:
encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel|
Encoded Example (The delimiters are emphasized):
UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc=
Decoded:
Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7
Note: The separators ( | : ;
) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string.
For more information, see Encoded Aspects in the Buying Integration Guide.
|
) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency.
The rating is a set of energy efficiency classes 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 this item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field.
eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: 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 watches and sneakers.
A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.
For example:
Item | Lot Definition | Lot Size |
---|---|---|
A package of 24 AA batteries | A box of 10 packages | 10 |
A P235/75-15 Goodyear tire | 4 tires | 4 |
Fashion Jewelry Rings | Package of 100 assorted rings | 100 |
Note: Lots are not supported in all categories.
Code so that your app gracefully handles any future changes to this list.
Code so that your app gracefully handles any future changes to this list.
Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID
request header specifying the supported marketplace (such as EBAY_GB
) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.For example:
"unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
For example, the following tells the buyer that the item is 7.99 per 100 grams.
"unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
For example, if the
DELAYED_DELIVERY
alert was returned for an item, it would indicate a delay in shipping by the seller.BUSINESS
. If the seller registers for a private account, the value returned in this field will be INDIVIDUAL
.Note: This designation is required by the tax laws in some countries.
This field is returned only on the following sites: EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, and EBAY_PL.
Code so that your app gracefully handles any future changes to this list.
Valid Values:
BUSINESS
or INDIVIDUAL
Example:
amdata=enc%3AAQAFAAAAkB1DmsmXf%2BqZ%2BCEMGdebW6oR75GCMdBmc4MCQ%2FCEPqgKHbT0jdWhPwfY5LdUs6HTaP0eBlwKE7Smy2eDslewF7l3xjwWxjqwzNAnsYgxn2PiGkTKbiQSQytFUiymdtANpk1qOnBOoMGMK%2BWsji7jYlvySSs9o9s24TxD6RqWZpNrltzOU7mfnv3H40SZ3YESzg%3D%3D
See Creating an EPN Tracking Link for information on EPN tracking links.
Format: UTC
yyyy-MM-ddThh:mm:ss.sssZ
For example:
Single SKU:
https://www.ebay.de/itm/2********0
MSKU:
https://www.ebay.com/itm/2********9?var=5********2
For example
https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F
For example
https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID
Valid values:
newborn
, infant
, toddler
, kids
, adult
.Note: All the item aspects, including this aspect, are returned in the localizedAspects container.