Skip to main content

GET/item_snapshot

The Hourly Snapshot feed file is generated each hour every day for most categories. This method lets you download an Hourly Snapshot TSV_GZIP (tab-separated value gzip) feed file containing the details of all the items that have changed within the specified day and hour for a specific category. This means to generate the 8AM file of items that have changed from 8AM and 8:59AM, the service starts at 9AM. You can retrieve the 8AM snapshot file at 10AM.

Snapshot feeds now include new listings. You can check itemCreationDate to identify listings that were newly created within the specified hour.

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

You can use the response from this method to update the item details of items stored in your database. By looking at the value of itemSnapshotDate for a given item, you will be able to tell which information is the latest.

Important: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated.

URLs for this method

  • Production URL: https://api.ebay.com/buy/feed/v1_beta/item_snapshot?
  • Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/item_snapshot?

Downloading feed files

Hourly snapshot feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Input

Resource URI (production)

GET https://api.ebay.com/buy/feed/v1_beta/item_snapshot?

URI parameters

ParameterTypeDescription
category_idstringAn eBay top-level category ID of the items to be returned in the feed file.

The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplace, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field.

For example:
  "categoryTreeNodeLevel": 1

For details see Get Categories for Buy APIs.

Restriction: Must be a top-level category other than Real Estate. Items listed under Real Estate L1 categories are excluded from all feeds in all marketplaces.

Occurrence: Required

snapshot_datestringThe date and hour of the snapshot feed file you want. Each file contains the items that changed within the hour in the specified category. So, the 9AM file contains the items that changed between 9AM and 9:59AM on the day specified. It takes 2 hours to generate a snapshot file, which means to get the file for 9AM the earliest you could submit the call is at 11AM.

There are 7 days of Hourly Snapshot feed files available.

Note: The Feed API uses GMT, so you must convert your local time to GMT. For example, if you lived in California and wanted the September 15th 7pm file, you would submit the following call:

item_snapshot?category_id=625&snapshot_date=2017-09-16T02:00:00.000Z

Format: UTC format (yyyy-MM-ddThh:00:00.000Z)

Files are generated on the hour, so minutes and seconds are always zeros.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
AcceptstringThe formats that the client accepts for the response.

A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate error codes that are returned in JSON format.

Default: application/json,text/tab-separated-values

Occurrence: Required

X-EBAY-C-MARKETPLACE-IDstringThe ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.

Occurrence: Required

RangestringThis header specifies the range in bytes of the chunks of the gzip file being returned.

Format: bytes=startpos-endpos

For example, the following retrieves the first 10 MBs of the feed file.

  Range bytes=0-10485760

For more information about using this header, see Retrieving a gzip feed file.

Maximum: 100 MB (10MB in the Sandbox)

Occurrence: Required

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/buy.item.feed

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
Content-rangeThe content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes.

Maximum range: 100 MB

The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.

  0-10/1000

The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.

   */1000

For more information and examples, see Retrieving a gzip feed file.
Last-ModifiedReturns the generated date of the feed file, which will be the latest file available. For example:
Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT

Response payload

Important: The successful response of this call is always a TSV_GZIP file. However, the response is shown as JSON fields for each column so that the value returned in each column can be explained. The order in which the response fields are listed is the order of the columns in the feed file.

{ /* ItemSnapshotResponse */
"items" : [
{ /* ItemSnapshot */
"itemId" : "string",
"title" : "string",
"gtin" : "string",
"brand" : "string",
"mpn" : "string",
"epid" : "string",
"alerts" : "string",
"color" : "string",
"size" : "string",
"gender" : "string",
}
]
}

Response fields

Output container/fieldTypeDescription
itemsarray of ItemSnapshot

The container for the array of items returned by the getItemSnapshotFeed method.

Note: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated.

Occurrence: Conditional

items.itemIdstring

The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2.

Occurrence: Always

items.availabilityAvailabilityEnum

An enumeration value representing the item's availability (possibility of being purchased).

Values:

  • AVAILABLE
  • TEMPORARILY_UNAVAILABLE
  • UNAVAILABLE
Code so that your app gracefully handles any future changes to this list.

Occurrence: Always

items.titlestring

The seller created title of the item. This text is an escaped string when special characters are present, using the following rules:

  • 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"

Occurrence: Conditional

items.imageUrlstring

The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted.

Occurrence: Conditional

items.categorystring

The label of the category of the item. For example: Toys & Hobbies|Action Figures|Comic Book Heroes .

Occurrence: Conditional

items.categoryIdstring

The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671.

Occurrence: Conditional

items.buyingOptionsstring

A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE.

Occurrence: Always

items.sellerUsernamestring

The seller's eBay user name.

Occurrence: Conditional

items.sellerFeedbackPercentagestring

The percentage of the seller's total positive feedback.

Occurrence: Conditional

items.sellerFeedbackScorestring

The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.

Occurrence: Conditional

items.gtinstring

The unique Global Trade Item Number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.

Occurrence: Conditional

items.brandstring

The name brand of the item, such as Nike, Apple, etc.

Occurrence: Conditional

items.mpnstring

The manufacturer part number, which is a number that is used in combination with brand to identify a product.

Occurrence: Conditional

items.epidstring

The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling.

Occurrence: Conditional

items.conditionIdstring

The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names.

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.conditionstring

The text describing the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.

Occurrence: Conditional

items.priceValuestring

The price of the item, which can be a discounted price.

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.

Occurrence: Conditional

items.priceCurrencyCurrencyCodeEnum

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

Occurrence: Conditional

items.primaryItemGroupIdstring

The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

items.primaryItemGroupTypestring

The item group type. Supported value: 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.

Occurrence: Conditional

items.itemEndDatestring

A timestamp indicating when the item's sale period will end based on its start date and duration. For Good 'Tail Cancelled items, no value is returned in this column.

Format: UTC (yyyy-MM-ddThh:mm:ss.sssZ).

Occurrence: Conditional

items.sellerItemRevisionstring

An identifier generated/incremented when a seller revises the item. There are two types of item revisions:

  • Seller changes, such as changing the title
  • eBay system changes, such as changing the quantity when an item is purchased
This ID is changed only when the seller makes a change to the item.

Occurrence: Conditional

items.itemLocationCountrystring

The country where the item is physically located.

Occurrence: Conditional

items.localizedAspectsstring

A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. 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.

Occurrence: Conditional

items.sellerTrustLevelSellerTrustLevelEnum

An enumeration value representing the eBay status of the seller.

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.

Occurrence: Conditional

items.imageAlteringProhibitedboolean

A boolean that indicates whether the images can be altered. If the value is 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.

Occurrence: Conditional

items.estimatedAvailableQuantityinteger

The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.

Occurrence: Conditional

items.availabilityThresholdTypeAvailabilityThresholdEnum

This column has a value only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be 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.

Occurrence: Conditional

items.availabilityThresholdinteger

This column has a value only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be "10", which is the threshold value.

Code so that your app gracefully handles any future changes to this value.

Occurrence: Conditional

items.itemSnapshotDatestring

This timestamp denotes the date and time the changes for that item were picked up and added to the snapshot feed file.

For example, let's say you have a snapshot feed file and also ran the getItem method. When you compare the same item information from the two sources, you see that the price in the getItem method response is different from the price in the snapshot feed file. By knowing the date and time you submitted the getItem method, you can use the itemSnapshotDate data to determine which price is the most current for this item.

Occurrence: Conditional

items.originalPriceValuestring

The original selling price of the item. This lets you surface a strikethrough price for the item.

Occurrence: Conditional

items.originalPriceCurrencyCurrencyCodeEnum

The currency of the originalPriceValue of the item and the discountAmount.

Occurrence: Conditional

items.discountAmountstring

The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14.

Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency.

Occurrence: Conditional

items.discountPercentagestring

The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.

Occurrence: Conditional

items.returnsAcceptedboolean

Indicates whether the seller accepts returns for the item.

Occurrence: Conditional

items.returnPeriodValueinteger

The amount of days that the buyer has to return the item after the purchase date. For example, if this value is 30, the return period is 30 days.

Occurrence: Conditional

items.returnPeriodUnitTimeDurationUnitEnum

An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years.

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.

Occurrence: Conditional

items.refundMethodRefundMethodEnum

An enumeration value representing how a buyer is refunded when an item is returned.

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.returnMethodReturnMethodEnum

An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund.

Occurrence: Conditional

items.returnShippingCostPayerReturnShippingCostPayerEnum

An enumeration value that indicates the party responsible for the return shipping costs when an item is returned.

Valid Values: BUYER or SELLER

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.energyEfficiencyClassstring

Indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating.

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.

Occurrence: Conditional

items.additionalImageUrlsstring

A pipe separated (|) 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.

Occurrence: Conditional

items.deliveryOptionsDeliveryOptionsEnum

A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer.

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.

Occurrence: Conditional

items.shipToIncludedRegionsstring

A pipe (|) 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.

Occurrence: Conditional

items.shipToExcludedRegionsstring

A pipe (|) 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.

Occurrence: Conditional

items.acceptedPaymentMethodsstring

This field is returned empty. For a list of payment methods available for a marketplace, see eBay help pages or the actual View Item page.

Occurrence: Conditional

items.qualifiedProgramsstring

A pipe separated list of the qualified programs available for the item, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE.

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.

Occurrence: Conditional

items.lotSizeinteger

The number of items in a lot. In other words, a lot size is the number of items that are being sold together.

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.

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.

Occurrence: Conditional

items.shippingCarrierCodestring

The name of the shipping provider, such as FedEx, or USPS.

Occurrence: Conditional

items.shippingServiceCodestring

The type of shipping service. For example, USPS First Class.

Occurrence: Conditional

items.shippingTypestring

The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.

Occurrence: Conditional

items.shippingCoststring

The final shipping cost for all the items after all discounts are applied.

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.

Occurrence: Conditional

items.shippingCostTypestring

Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.additionalShippingCostPerUnitstring

Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).

Occurrence: Conditional

items.quantityUsedForEstimateinteger

The number of items used when calculating the shipping estimation information.

Occurrence: Conditional

items.unitPricestring

This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.

For example:

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"

Occurrence: Conditional

items.unitPricingMeasurestring

The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.

For example, the following tells the buyer that the item is 7.99 per 100 grams.

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"

Occurrence: Conditional

items.inferredEpidstring

The ePID (eBay Product ID of a product in the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

If the seller actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.

Occurrence: Conditional

items.itemCreationDatestring

A timestamp indicating when the item was created. The format is UTC (yyyy-MM-ddThh:mm:ss.sssZ).

Occurrence: Always

items.legacyItemIdstring

The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.

Occurrence: Always

items.alertsstring

A pipe-separated list of alerts available for the item.

For example, if the DELAYED_DELIVERY alert was returned for an item, it would indicate a delay in shipping by the seller.

Occurrence: Conditional

items.sellerAccountTypestring

A string value that specifies whether the seller is a business or an individual. This is determined when the seller registers with eBay. If the seller registers for a business account, the value returned in this field will be 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

Occurrence: Conditional

items.tyreLabelImageUrlstring

The URL to the image that shows the information on the tyre label.

Occurrence: Conditional

items.ageGroupstring

The age group that the product is recommended for.

Valid values: newborn, infant, toddler, kids, adult.

Occurrence: Conditional

items.colorstring

The color of the item.

Occurrence: Conditional

items.patternstring

(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley.

Note: All the item aspects, including this aspect, are returned in the localizedAspects container.

Occurrence: Conditional

items.sizestring

The size of the item.

Occurrence: Conditional

items.genderstring

In cases where items could vary by gender, this specifies for which gender the product is intended. Possible values include male, female, and unisex.

Occurrence: Conditional

items.materialstring

The material that the item is made of.

Occurrence: Conditional

items.totalUnitsstring

For an item that is priced by the unit, the total number of units that are on offer. For example, if the item is priced by the meter and 50 cm is on offer, the totalUnits would be 0.5 m.

Occurrence: Conditional

items.defaultImageUrlstring

URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field.

For example

https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F

Occurrence: Conditional

items.itemWebUrlstring

The URL of the View Item page of the item.

For example:

Single SKU:
https://www.ebay.de/itm/2********0

MSKU:
https://www.ebay.com/itm/2********9?var=5********2

Occurrence: Conditional

items.itemAffiliateWebUrlstring

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

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

Occurrence: Conditional

items.descriptionstring

The seller created description of the item.

For example:

Brand-new, unused, and unworn. Not in original packaging.

Occurrence: Conditional

items.changeMetadatastring

Status change indicator of the listing.

Values:

  • PRICE_CHANGE
  • QUANTITY_CHANGE
  • TITLE_CHANGE
  • DELETED
  • NEW
  • ENDED

Occurrence: Conditional

items.ecoParticipationFeeValuestring

The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item.

Occurrence: Conditional

items.ecoParticipationFeeCurrencystring

The currency in which the Eco Participation Fee for the item is paid.

Occurrence: Conditional

items.takeBackPolicyLabelstring

The seller-defined label of the TAKE_BACK custom policy for the item. A TAKE_BACK policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases a new one.

Occurrence: Conditional

items.takeBackPolicyDescriptionstring

The seller-defined description of the TAKE_BACK custom policy for the item.

Occurrence: Conditional

items.authenticityGuaranteeServiceIdstring

The unique identifier for the Authenticity Guarantee service associated with the item.

Occurrence: Conditional

items.authenticityGuaranteeSelectionOptionalityEnum

An indication of whether the Authenticity Guarantee service is optional or mandatory for the item.

Occurrence: Conditional

items.authenticityGuaranteeFeeValuestring

The price of the Authenticity Guarantee service for the item.

Note: The price returned in this field indicates the service fee for a single item quantity.

Occurrence: Conditional

items.authenticityGuaranteeFeeCurrencystring

The currency used for the Authenticity Guarantee service fee.

Occurrence: Conditional

items.couponDiscountTypestring

The type of discount that the coupon applies.

Note: If all coupon fields return null values, it indicates that the item never had a coupon, or that the coupon has been removed. Please ensure that you update your inventory accordingly.

Occurrence: Conditional

items.couponRedemptionCodestring

The redemption code for the coupon.

Occurrence: Conditional

items.couponMessagestring

A description of the coupon.

Occurrence: Conditional

items.couponTermsWebUrlstring

The URL to the coupon terms of use.

Occurrence: Conditional

items.couponDiscountValuestring

The discount amount after the coupon is applied.

Occurrence: Conditional

items.couponDiscountCurrencystring

The currency used to specify the coupon discount value.

Occurrence: Conditional

items.couponExpirationDatestring

The expiration date for the coupon.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
204No Content
This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters for details.
206Partial Content
400Bad request
403Forbidden
404Not found
416Range not satisfiable
500Internal server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
13000API_FEEDREQUESTThe request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
13004API_FEEDREQUESTThe 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
13006API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Wait a few minutes and retry the call. If that doesn't work, contact eBay Support.
13007API_FEEDREQUESTThe feed file requested cannot be found. It is possible the file requested is in the process of being generated. Either change the date or try the call again later.
13010API_FEEDREQUESTThe mandatory 'category_id' query parameter is missing.
13012API_FEEDREQUESTThe marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}
13013API_FEEDREQUESTThe mandatory 'X-EBAY-C-MARKETPLACE-ID' header is missing. Valid values: {allowedMarketplaces}
13014API_FEEDREQUESTThe marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}
13015API_FEEDREQUESTThe mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
13016API_FEEDREQUESTThe 'Range' request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call.
13017API_FEEDREQUESTThe 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
13018API_FEEDREQUESTThe start position in the range header is invalid.
13019API_FEEDREQUESTThe end position in the range header is invalid.
13020API_FEEDREQUESTThe mandatory 'snapshot_date' query parameter is missing.
13021API_FEEDREQUESTThe 'snapshot_date' query parameter is invalid.Valid format is 'yyyy-MM-ddTHH:mm:ss'
13022API_FEEDREQUESTThe 'category_id' {category_id} submitted is not supported.
13023API_FEEDBUSINESSInsufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.
13024API_FEEDBUSINESSInsufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Download an Hourly Changed Item Feed File

This sample returns a GZIP file with the items that have changed on August 30, 2018 between 8-9am UTC in the Cameras & Photo category. In this example, the size of the file being returned is 142MB (148897792 bytes) and the request Range header specifies to return the first 10MB (10485760 bytes).

Input

The inputs are category_id, and snapshot_date in UTC format (yyyy-MM-ddThh:mm:ss.sssZ) based on GMT, URI parameters.

The request parameters are: Range bytes=0-10485760 and X-EBAY-C-MARKETPLACE-ID EBAY_US. For more information about using these headers, see HTTP request headers.

GEThttps://api.ebay.com/buy/feed/v1_beta/item_snapshot?category_id=625&snapshot_date=2018-08-30T08:00:00.000z

Output

If the call is successful, the portion of the file specified by the Range header, is returned. The call returns a 206 HTTP status and the Content-range bytes=0-10485760/148897792 response header.