openapi: 3.0.0
info:
title: Item Feed Service
description: Note: This is a (Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.
The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file of the items that have changed within an hour for a specific category, date and marketplace.
In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.
contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1_beta.35.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /buy/feed/v1_beta paths: /item: get: tags: - item description: 'This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.NEWLY_LISTED
)ALL_ACTIVE
)application/json,text/tab-separated-values
required: true
schema:
type: string
- name: X-EBAY-C-MARKETPLACE-ID
in: header
description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.X-EBAY-C-MARKETPLACE-ID = EBAY_US
bytes=startpos-endpos
Range bytes=0-10485760
"categoryTreeNodeLevel": 1
NEWLY_LISTED
) you want to retrieve.ALL_ACTIVE
), the date is ignored and the latest file is returned. The date the Item Bootstrap feed file was generated is returned in the Last-Modified response header.yyyyMMdd
NEWLY_LISTED
0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemResponse'
'204':
description: No Content 0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemResponse'
'400':
description: Bad request
x-response-codes:
errors:
'13000':
domain: API_FEED
category: REQUEST
description: The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
'13003':
domain: API_FEED
category: REQUEST
description: 'The ''feed_scope'' {feed_scope} submitted is invalid. Valid values: {feedScopes}'
'13004':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
'13005':
domain: API_FEED
category: REQUEST
description: 'The ''date'' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.'
'13007':
domain: API_FEED
category: REQUEST
description: The 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.
'13009':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''feed_scope'' query parameter is missing. Valid values: {feedScopes}'
'13010':
domain: API_FEED
category: REQUEST
description: The mandatory 'category_id' query parameter is missing.
'13011':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.'
'13012':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}'
'13013':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}'
'13014':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}'
'13015':
domain: API_FEED
category: REQUEST
description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
'13016':
domain: API_FEED
category: REQUEST
description: 'The ''Range'' request header format is invalid. Format: ''bytes=start position-end position''. For help, see the API Reference documentation for this call.'
'13017':
domain: API_FEED
category: REQUEST
description: The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
'13018':
domain: API_FEED
category: REQUEST
description: The start position in the range header is invalid.
'13019':
domain: API_FEED
category: REQUEST
description: The end position in the range header is invalid.
'13022':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is not supported.
'403':
description: Forbidden
x-response-codes:
errors:
'13023':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.
'13024':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.
'404':
description: Not found
'409':
description: Conflict
'416':
description: Range not satisfiable
'500':
description: Internal Server Error
x-response-codes:
errors:
'13006':
domain: API_FEED
category: APPLICATION
description: There 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.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/buy.item.feed
/item_group:
get:
tags:
- item_group
description: 'This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. NEWLY_LISTED
)ALL_ACTIVE
)application/json,text/tab-separated-values
required: true
schema:
type: string
- name: X-EBAY-C-MARKETPLACE-ID
in: header
description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.X-EBAY-C-MARKETPLACE-ID = EBAY_US
bytes=startpos-endpos
Range bytes=0-10485760
"categoryTreeNodeLevel": 1
NEWLY_LISTED
) you want. The date is required only for the daily Item Group feed file. If you specify a date for the Item Group Bootstrap file (feed_scope=ALL_ACTIVE
), the date is ignored and the latest file is returned. The date the Item Group Bootstrap feed file was generated is returned in the Last-Modified response header.
The Item Group feed files are generated every day and there are 14 daily files available.
There is a 48 hour latency when generating the files. This means on July 10, the latest feed file you can download is July 8.
Note: The generated files are stored using MST (US Mountain Standard Time), which is -7 hours UTC time.yyyyMMdd
NEWLY_LISTED
0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemGroupResponse'
'204':
description: No Content 0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemGroupResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'13000':
domain: API_FEED
category: REQUEST
description: The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
'13003':
domain: API_FEED
category: REQUEST
description: 'The ''feed_scope'' {feed_scope} submitted is invalid. Valid values: {feedScopes}'
'13004':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
'13005':
domain: API_FEED
category: REQUEST
description: 'The ''date'' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.'
'13007':
domain: API_FEED
category: REQUEST
description: The 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.
'13009':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''feed_scope'' query parameter is missing. Valid values: {feedScopes}'
'13010':
domain: API_FEED
category: REQUEST
description: The mandatory 'category_id' query parameter is missing.
'13011':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.'
'13012':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}'
'13013':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}'
'13014':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}'
'13015':
domain: API_FEED
category: REQUEST
description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
'13016':
domain: API_FEED
category: REQUEST
description: 'The ''Range'' request header format is invalid. Format: ''bytes=start position-end position''. For help, see the API Reference documentation for this call.'
'13017':
domain: API_FEED
category: REQUEST
description: The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
'13018':
domain: API_FEED
category: REQUEST
description: The start position in the range header is invalid.
'13019':
domain: API_FEED
category: REQUEST
description: The end position in the range header is invalid.
'13022':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is not supported.
'403':
description: Forbidden
x-response-codes:
errors:
'13023':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.
'13024':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.
'404':
description: Not found
'409':
description: Conflict
'416':
description: Range not satisfiable
'500':
description: Internal Server Error
x-response-codes:
errors:
'13006':
domain: API_FEED
category: APPLICATION
description: There 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.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/buy.item.feed
/item_snapshot:
get:
tags:
- item_snapshot
description: '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.UNAVAILABLE
, only the itemId and availability columns are populated. application/json,text/tab-separated-values
required: true
schema:
type: string
- name: X-EBAY-C-MARKETPLACE-ID
in: header
description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.X-EBAY-C-MARKETPLACE-ID = EBAY_US
bytes=startpos-endpos
Range bytes=0-10485760
"categoryTreeNodeLevel": 1
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
yyyy-MM-ddThh:00:00.000Z
0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemSnapshotResponse'
'204':
description: No Content 0-10/1000
*/1000
Wed, 21 Oct 2015 07:28:00 GMT
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemSnapshotResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'13000':
domain: API_FEED
category: REQUEST
description: The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
'13004':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
'13007':
domain: API_FEED
category: REQUEST
description: The 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.
'13010':
domain: API_FEED
category: REQUEST
description: The mandatory 'category_id' query parameter is missing.
'13012':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}'
'13013':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}'
'13014':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}'
'13015':
domain: API_FEED
category: REQUEST
description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
'13016':
domain: API_FEED
category: REQUEST
description: 'The ''Range'' request header format is invalid. Format: ''bytes=start position-end position''. For help, see the API Reference documentation for this call.'
'13017':
domain: API_FEED
category: REQUEST
description: The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
'13018':
domain: API_FEED
category: REQUEST
description: The start position in the range header is invalid.
'13019':
domain: API_FEED
category: REQUEST
description: The end position in the range header is invalid.
'13020':
domain: API_FEED
category: REQUEST
description: The mandatory 'snapshot_date' query parameter is missing.
'13021':
domain: API_FEED
category: REQUEST
description: The 'snapshot_date' query parameter is invalid.Valid format is 'yyyy-MM-ddTHH:mm:ss'
'13022':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is not supported.
'403':
description: Forbidden
x-response-codes:
errors:
'13023':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.
'13024':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.
'404':
description: Not found
'409':
description: Conflict
'416':
description: Range not satisfiable
'500':
description: Internal server error
x-response-codes:
errors:
'13006':
domain: API_FEED
category: APPLICATION
description: There 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.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/buy.item.feed
/item_priority:
get:
tags:
- item_priority
description: 'Using this method, you can download a TSV_GZIP (tab separated value gzip) Item Priority feed file, which allows you to track changes (deltas) in the status of your priority items, such as when an item is added or removed from a campaign. The delta feed tracks the changes to the status of items within a category you specify in the input URI. You can also specify a specific date for the feed you want returned.Important! You must consume the daily feeds (Item, Item Group) before consuming the Item Priority feed. This ensures that your inventory is up to date.
application/json,text/tab-separated-values
required: true
schema:
type: string
- name: X-EBAY-C-MARKETPLACE-ID
in: header
description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.X-EBAY-C-MARKETPLACE-ID = EBAY_US
bytes = 0-102400
.'
required: true
schema:
type: string
- name: category_id
in: query
description: 'This query parameter specifies the eBay top-level category ID of the items to be returned in the feed file."categoryTreeNodeLevel": 1
yyyyMMdd
0-100/1000
where 0-100
is the content length of the current response and 1000
is the total content length. In case of a 416 status code, content-range would be */1000
, which denotes an invalid range header.'
Last-Modified:
schema:
type: string
description: 'Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
.'
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemPriorityResponse'
'204':
description: No Content
'206':
description: Partial Content
headers:
Content-range:
schema:
type: string
description: 'The content range for the current request. Typically in the format : 0-100/1000
where 0-100
is the content length of the current response and 1000
is the total content length. In case of a 416 status code, content-range would be */1000
, which denotes an invalid range header.'
Last-Modified:
schema:
type: string
description: 'Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
.'
content:
text/tab-separated-values:
schema:
$ref: '#/components/schemas/ItemPriorityResponse'
'400':
description: Bad Request
x-response-codes:
errors:
'13000':
domain: API_FEED
category: REQUEST
description: The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
'13004':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
'13005':
domain: API_FEED
category: REQUEST
description: 'The ''date'' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.'
'13010':
domain: API_FEED
category: REQUEST
description: The mandatory 'category_id' query parameter is missing.
'13011':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.'
'13012':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}'
'13013':
domain: API_FEED
category: REQUEST
description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}'
'13014':
domain: API_FEED
category: REQUEST
description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}'
'13015':
domain: API_FEED
category: REQUEST
description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
'13016':
domain: API_FEED
category: REQUEST
description: 'The ''Range'' request header format is invalid. Format: ''bytes=start position-end position''. For help, see the API Reference documentation for this call.'
'13018':
domain: API_FEED
category: REQUEST
description: The start position in the range header is invalid.
'13019':
domain: API_FEED
category: REQUEST
description: The end position in the range header is invalid.
'13022':
domain: API_FEED
category: REQUEST
description: The 'category_id' {category_id} submitted is not supported.
'403':
description: Forbidden
x-response-codes:
errors:
'13023':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical support for further assistance.
'13024':
domain: API_FEED
category: BUSINESS
description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical support for further assistance.
'404':
description: Not found
x-response-codes:
errors:
'13007':
domain: API_FEED
category: REQUEST
description: The 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.
'409':
description: Conflict
'416':
description: Range not satisfiable
x-response-codes:
errors:
'13017':
domain: API_FEED
category: REQUEST
description: The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
'500':
description: Internal server error
x-response-codes:
errors:
'13006':
domain: API_FEED
category: APPLICATION
description: There 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.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/buy.item.feed
components:
schemas:
Error:
type: object
properties:
category:
type: string
description: Identifies the type of erro.
domain:
type: string
description: Name for the primary system where the error occurred. This is relevant for application errors.
errorId:
type: integer
description: A unique number to identify the error.
format: int32
inputRefIds:
type: array
description: An array of request elements most closely associated to the error.
items:
type: string
longMessage:
type: string
description: A more detailed explanation of the error.
message:
type: string
description: Information on how to correct the problem, in the end user's terms and language where applicable.
outputRefIds:
type: array
description: An array of request elements most closely associated to the error.
items:
type: string
parameters:
type: array
description: An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.
items:
$ref: '#/components/schemas/ErrorParameter'
subdomain:
type: string
description: 'Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.'
description: This type defines the fields that can be returned in an error.
ErrorParameter:
type: object
properties:
name:
type: string
description: The object of the error.
value:
type: string
description: The value of the object.
Item:
type: object
properties:
itemId:
type: string
description: The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2
.
title:
type: string
description: The seller created title of the item. This text is an escaped string when special characters are present, using the following rules: 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
.'
buyingOptions:
type: string
description: 'A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE
.Important! This field no longer returns values and is scheduled for deprecation.
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.'
priceCurrency:
type: string
description: 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. For implementation help, refer to eBay API documentation
primaryItemGroupId:
type: string
description: 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.
primaryItemGroupType:
type: string
description: 'The item group type. Supported value: SELLER_DEFINED_VARIATIONS
, indicates that the item group was created by the seller. Important! This field no longer returns values and is scheduled for deprecation.
yyyy-MM-ddThh:mm:ss.sssZ
'
sellerItemRevision:
type: string
description: 'An identifier generated/incremented when a seller revises the item. There are two types of item revisions: 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.
' sellerTrustLevel: type: string description: An enumeration value representing the eBay status of the seller.TOP_RATED
, ABOVE_STANDARD
, or an empty value. TOP_RATED
or ABOVE_STANDARD
.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.
' estimatedAvailableQuantity: type: integer description: The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. MORE_THAN
, which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. DAY
. For implementation help, refer to eBay API documentation
refundMethod:
type: string
description: 'An enumeration value that indicates how a buyer is refunded when an item is returned. Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
BUYER
or SELLER
Important! This field no longer returns values and is scheduled for deprecation.
|
) separated alphabetical list of the geographic countries and regions where the seller will ship the item. ;
). COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
|
) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. ;
). COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
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.
' additionalImageUrls: type: string description: '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.'
originalPriceValue:
type: string
description: 'The original selling price of the item. This lets you surface a strikethrough price for the item. '
originalPriceCurrency:
type: string
description: The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation
discountAmount:
type: string
description: '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.
' discountPercentage: type: string description: The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20. energyEfficiencyClass: type: string description: Indicates the European energy efficiency rating (EEK) of the item. Data is returned in this column only if the seller specified the energy efficiency rating.EBAY_PLUS
: Indicates an item is eligible for eBay Plus. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items.AUTHENTICITY_GUARANTEE
: Indicates that the item is eligible for the eBay Authenticity Guarantee program. This program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.FEATURED
: Indicates that an item is eligible to be placed in a Focus Category. Focus Categories are specific categories dedicated to a certain type of product that allow a seller to better reach their target audience and increase their sales.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 |
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
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.'
shippingCostType:
type: string
description: 'Indicates the class of the shipping cost. Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
"unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
'
unitPricingMeasure:
type: string
description: 'The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. "unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
'
legacyItemId:
type: string
description: 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.
alerts:
type: string
description: A pipe-separated list of alerts available for the item.DELAYED_DELIVERY
alert was returned for an item, it would indicate a delay in shipping by the seller.
sellerAccountType:
type: string
description: '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
.BUSINESS
or INDIVIDUAL
'
tyreLabelImageUrl:
type: string
description: The URL to the image that shows the information on the tyre label.
priorityListingPayload:
type: string
description: 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. amdata=enc%3AAQAFAAAAkB1DmsmXf%2BqZ%2BCEMGdebW6oR75GCMdBmc4MCQ%2FCEPqgKHbT0jdWhPwfY5LdUs6HTaP0eBlwKE7Smy2eDslewF7l3xjwWxjqwzNAnsYgxn2PiGkTKbiQSQytFUiymdtANpk1qOnBOoMGMK%2BWsji7jYlvySSs9o9s24TxD6RqWZpNrltzOU7mfnv3H40SZ3YESzg%3D%3D
yyyy-MM-ddThh:mm:ss.sssZ
'
itemWebUrl:
type: string
description: The URL of the View Item page of the item. https://www.ebay.de/itm/2********0
https://www.ebay.com/itm/2********9?var=5********2
defaultImageUrl:
type: string
description: URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field.https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F
itemAffiliateWebUrl:
type: string
description: The URL of the View Item page of the item, with the affiliate tracking ID appended to it.https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID
ageGroup:
type: string
description: The age group that the product is recommended for. newborn
, infant
, toddler
, kids
, adult
.
color:
type: string
description: The color of the item.
pattern:
type: string
description: Text describing the pattern used on the item. For example, paisley.H200|H221
'
hazmatStatementDescriptions:
type: string
description: 'The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example: encoded(Unstable explosives)|encoded(Flammable gas)
'
hazmatPictogramIds:
type: string
description: 'The IDs of hazardous material pictograms, separated by the pipe symbol. For example: SGH01|SGH02
'
hazmatPictogramDescriptions:
type: string
description: 'The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example: encoded(exploding bomb)|encoded(flame)
'
hazmatPictogramImageUrls:
type: string
description: 'The image URLs of hazardous material pictograms, separated by the pipe symbol. For example: https://img1|https://img2
'
hazmatAdditionalInformation:
type: string
description: Base64 encoded additional information about the hazardous material.
repairScore:
type: string
description: A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.Name:Value
TmFtZQ==:VmFsdWU=
Name1:Value1;Name2:Value2
TmFtZTE=:VmFsdWUx;TmFtZTI=:VmFsdWUy
Name1:Value1|Value2|Value3;Name2:Value1|Value2|Value3
TmFtZTE=:VmFsdWUx|VmFsdWUy|VmFsdWUz;TmFtZTI=:VmFsdWUx|VmFsdWUy|VmFsdWUz
: ; |
) are not encoded. You must decode each name, and value or values separately. You cannot decode the entire string. SELLER_DEFINED_VARIATIONS
, indicates that the item group was created by the seller. Important! This field no longer returns values and is scheduled for deprecation.
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"
|
) list of the aspect (variation) names for this item group. The aspect name is Base64 encoded. Note: This column can contain multiple values. Encoded Format:
aspectName|aspectName
Encoded Example (The delimiters are emphasized):
Q29sb3I=|U2l6ZQ==
Decoded:
Color|Size
|
) list of URLs for the additional images for the item group. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.'
imageAlteringProhibited:
type: boolean
description: '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.
' description: The type that defines the columns returned in the Item Group feed file. ItemGroupResponse: type: object properties: itemGroups: type: array description: The container for the array of items groups returned by the getItemGroupFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values for each item. The header labels match the fields that are described in the Response fields section. items: $ref: '#/components/schemas/ItemGroup' description: The type that defines the array for the items returned in the Item Group feed file. ItemPriority: type: object properties: itemId: type: string description: The unique identifier of an item in eBay RESTful format. An example would bev1|1********2|4********2
.
priorityListingPayload:
type: string
description: 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. _trkparms=ispr%3D1&amdata=enc%3AAQAFAAAAkB1DmsmXf%2BqZ%2BCEMGdebW6oR75GCMdBmc4MCQ%2FCEPqgKHbT0jdWhPwfY5LdUs6HTaP0eBlwKE7Smy2eDslewF7l3xjwWxjqwzNAnsYgxn2PiGkTKbiQSQytFUiymdtANpk1qOnBOoMGMK%2BWsji7jYlvySSs9o9s24TxD6RqWZpNrltzOU7mfnv3H40SZ3YESzg%3D%3D
ADDED_TO_CAMPAIGN
REMOVED_FROM_CAMPAIGN
TRACKING_PAYLOAD_REFRESHED
ADDED_TO_CAMPAIGN|TRACKING_PAYLOAD_REFRESHED
).v1|1**********2|4**********2
.
availability:
type: string
description: 'An enumeration value representing the item''s availability (possibility of being purchased). 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
.'
buyingOptions:
type: string
description: 'A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE
.Important! This field no longer returns values and is scheduled for deprecation.
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.'
priceCurrency:
type: string
description: 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. For implementation help, refer to eBay API documentation
primaryItemGroupId:
type: string
description: 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.
primaryItemGroupType:
type: string
description: 'The item group type. Supported value: SELLER_DEFINED_VARIATIONS
, indicates that the item group was created by the seller. Important! This field no longer returns values and is scheduled for deprecation.
yyyy-MM-ddThh:mm:ss.sssZ
'
sellerItemRevision:
type: string
description: 'An identifier generated/incremented when a seller revises the item. There are two types of item revisions: 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.
' sellerTrustLevel: type: string description: An enumeration value representing the eBay status of the seller.TOP_RATED
, ABOVE_STANDARD
, or an empty value. TOP_RATED
or ABOVE_STANDARD
.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.
' estimatedAvailableQuantity: type: integer description: The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. MORE_THAN
, which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. yyyy-MM-ddThh:mm:ss.sssZ
'
originalPriceValue:
type: string
description: 'The original selling price of the item. This lets you surface a strikethrough price for the item. '
originalPriceCurrency:
type: string
description: The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation
discountAmount:
type: string
description: The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. 30
, the return period is 30 days.
format: int32
returnPeriodUnit:
type: string
description: An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years. DAY
. For implementation help, refer to eBay API documentation
refundMethod:
type: string
description: 'An enumeration value representing how a buyer is refunded when an item is returned. Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
BUYER
or SELLER
|
) 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.'
deliveryOptions:
type: string
description: 'A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer. |
) separated alphabetical list of the geographic countries and regions where the seller will ship the item. ;
). COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
|
) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. ;
). COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;
Important! This field no longer returns values and is scheduled for deprecation.
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 |
Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
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.'
shippingCostType:
type: string
description: 'Indicates the class of the shipping cost. Important! This field no longer returns values and is scheduled for deprecation.
Important! This field no longer returns values and is scheduled for deprecation.
"unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
'
unitPricingMeasure:
type: string
description: 'The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. "unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
'
inferredEpid:
type: string
description: 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. yyyy-MM-ddThh:mm:ss.sssZ
'
legacyItemId:
type: string
description: 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.
alerts:
type: string
description: A pipe-separated list of alerts available for the item.DELAYED_DELIVERY
alert was returned for an item, it would indicate a delay in shipping by the seller.
sellerAccountType:
type: string
description: '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
.BUSINESS
or INDIVIDUAL
'
tyreLabelImageUrl:
type: string
description: The URL to the image that shows the information on the tyre label.
ageGroup:
type: string
description: The age group that the product is recommended for. newborn
, infant
, toddler
, kids
, adult
.
color:
type: string
description: The color of the item.
pattern:
type: string
description: (Primary Item Aspect) Text describing the pattern used on the item. For example, paisley.https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F
itemWebUrl:
type: string
description: The URL of the View Item page of the item. https://www.ebay.de/itm/2********0
https://www.ebay.com/itm/2********9?var=5********2
itemAffiliateWebUrl:
type: string
description: The URL of the View Item page of the item, with the affiliate tracking ID appended to it.https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID
description:
type: string
description: The seller created description of the item.Brand-new, unused, and unworn. Not in original packaging.
changeMetadata:
type: string
description: Status change indicator of the listing.PRICE_CHANGE
QUANTITY_CHANGE
TITLE_CHANGE
DELETED
NEW
ENDED
yyyy-MM-ddThh:mm:ss.sssZ
'
hazmatSignalWordId:
type: string
description: The ID of the signal word for the hazardous material.
hazmatSignalWord:
type: string
description: The localized signal word for the hazardous material, such as 'Danger'.
hazmatStatementIds:
type: string
description: 'The IDs of hazardous material statements, separated by the pipe symbol. For example: H200|H221
'
hazmatStatementDescriptions:
type: string
description: 'The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example: encoded(Unstable explosives)|encoded(Flammable gas)
'
hazmatPictogramIds:
type: string
description: 'The IDs of hazardous material pictograms, separated by the pipe symbol. For example: SGH01|SGH02
'
hazmatPictogramDescriptions:
type: string
description: 'The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example: encoded(exploding bomb)|encoded(flame)
'
hazmatPictogramImageUrls:
type: string
description: 'The image URLs of hazardous material pictograms, separated by the pipe symbol. For example: https://img1|https://img2
'
hazmatAdditionalInformation:
type: string
description: Base64 encoded additional information about the hazardous material.
repairScore:
type: string
description: A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.
conditionDescriptors:
type: string
description: 'Note: Condition descriptors are currently only available for the following trading card categories:Name:Value
TmFtZQ==:VmFsdWU=
Name1:Value1;Name2:Value2
TmFtZTE=:VmFsdWUx;TmFtZTI=:VmFsdWUy
Name1:Value1|Value2|Value3;Name2:Value1|Value2|Value3
TmFtZTE=:VmFsdWUx|VmFsdWUy|VmFsdWUz;TmFtZTI=:VmFsdWUx|VmFsdWUy|VmFsdWUz
: ; |
) are not encoded. You must decode each name, and value or values separately. You cannot decode the entire string. Note: When the value of the availability column is UNAVAILABLE
, only the itemId and availability columns are populated.
Note: When the value of the availability column is UNAVAILABLE
, only the itemId and availability columns are populated.