openapi: 3.0.0 info: title: Browse API description: The Browse API has the following resources:The item_summary, search_by_image, and item resource calls require an Application access token. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.19.6 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /buy/browse/v1 paths: /item_summary/search: get: tags: - item_summary description: This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these.

Note: Only listings where FIXED_PRICE (Buy It Now) is a buying option are returned by default. To retrieve listings that do not have FIXED_PRICE as a buying option, the buyingOptions filter can be used to retrieve those listings.

Note that an auction listing enabled with the Buy it Now feature will initially show AUCTION and FIXED_PRICE as buying options, but if/when that auction listing receives a qualifying bid, only AUCTION remains as a buying option. If this happens, the buyingOptions filter would need to be used to retrieve that auction listing.

This method also supports the following:For additional information and examples of these capabilities, refer to Browse API in the Buying Integration Guide.

Pagination and sort controls

There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that are returned. By default, results are sorted by Best Match. For more information about Best Match, refer to Best Match.

Restrictions

This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, refer to API Restrictions.

eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site. operationId: search parameters: - name: aspect_filter in: query description: This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

Note: The category ID must be specified twice:These two values must be the same.
For example, to return items for a woman's red shirt, issue the following request:
/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}
To get a list of the aspect pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS as illustrated here:
/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS
Note: The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter.

The following example illustrates the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:
/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed\|Stü|Nike}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter required: false schema: type: string - name: auto_correct in: query description: A query parameter that enables auto correction.

A sample is shown below:
/buy/browse/v1/item_summary/search?auto_correct=KEYWORD
Note: Auto correction is currently supported in the following marketplaces:
Valid Values: KEYWORD required: false schema: type: string - name: category_ids in: query description: The category ID is used to limit the results that are returned. This field may pass in one category ID or a comma separated list of IDs as illustrated in the following examples:
/buy/browse/v1/item_summary/search?category_ids=29792
/buy/browse/v1/item_summary/search?category_ids=267,29792
Note: Currently, you can pass in only one category ID per request.
To refine the set of information that is returned, category_ids may be combined with EITHER:For example, when looking of a toy phone, simply searching for "phone" will return mobile phones because that is the "Best Match" for the search. To further refine the request to include toy phones, include the Toys & Hobbies category ID as illustrated here:
/buy/browse/v1/item_summary/search?q=phone&category_ids=220
Because the list of eBay category IDs is not published and category IDs are not the same across all eBay marketplaces, category IDs may be determined by:Note: If a top-level (L1) category is specified, you must also include a q query parameter. required: false schema: type: string - name: charity_ids in: query description: 'The charity ID filters results to return only those items associated with the specified charity.

Note: charity_ids is only supported by the US and UK marketplaces.
Charity ID is a charity''s unique identification number:
charity_ids may be retrieved/determined as follows:Up to 20 comma-separated charity_ids may be specified in each query. Additionally, charity_ids may be combined with category_ids and/or q keyword values to further filter returned results.

A sample query using charity_ids is:
/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469
' required: false schema: type: string - name: compatibility_filter in: query description: 'This field specifies the attributes used to define a specific product. The service searches for items matching the keyword, or matching the keyword and a product attribute value in the title of the item.

Note: The only products supported are cars, trucks, and motorcycles.
For example, if the keyword is brakes and compatibility-filter=Year:2018;Make:BMW, the items returned are items with brakes, 2018, or BMW in the title.

The service uses the product attributes to determine whether the item is compatible. The service returns the attributes that are compatible and the CompatibilityMatchEnum value that indicates how well the item matches the attributes.

Tip: Refer to the Samples section for a detailed example.


Best Practice: Submit all of the product attributes for the specific product.

To find the attributes and values for a specific marketplace, use the getCompatibilityProperties method in the Taxonomy API.

For more information, refer to Check compatibility in the Buying Integration Guide.

Note: Testing in Sandbox is only supported using mock data. Refer to Testing search in the Sandbox for details.
Required: For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityFilter' required: false schema: type: string - name: epid in: query description: The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the specified ePID.

Use the product_summary/search method in the Catalog API to search for the ePID of the product.

For example:
/buy/browse/v1/item_summary/search?epid=15032
Note: When constructing a query, epid may be combined with a gtin value. However, do not specify keywords using the q parameter — keywords cannot be used in conjunction with an epid. required: false schema: type: string - name: fieldgroups in: query description: A comma-separated list of values that controls what is returned in the response. The default is MATCHING_ITEMS, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information.

Valid Values:Default: MATCHING_ITEMS required: false schema: type: string - name: filter in: query description: 'An array of field filters that can be used to limit/customize the result set.

Refer to Buy API Field Filters for additional information and examples of all supported filters.

For example, to filter shirts based on a specific range of prices, include the filter illustrated here:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]
Filters may also be combined within a single request as illustrated in the sample below which further refines results to return only those shirts available from specific sellers:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField' required: false schema: type: string - name: gtin in: query description: This field lets you search by the Global Trade Item Number of an item as defined by https://www.gtin.info.

For example:
/buy/browse/v1/item_summary/search?gtin=099482432621
Note: You can search only by UPC (Universal Product Code). To search using another GTIN format, you must search by keyword.Note: When constructing a query, gtin may be combined with an epid value. However, do not specify keywords using the q parameter — keywords cannot be used in conjunction with gtin. required: false schema: type: string - name: limit in: query description: The number of items from the result set returned in a single page.

Note: If a value is set in the limit field, the value of offset must be either zero or a multiple of the limit value. An error is returned for invalid offset values.
Note: This method can return a maximum of 10,000 items in one results set.
Min: 1

Max: 200

Default: 50 required: false schema: type: string - name: offset in: query description: 'Specifies the number of items to skip in the result set. This is used with the limit field to control the pagination of the output.

For example:Note: The value of offset must be either zero or a multiple of the value set in the limit field. An error is returned for invalid offset values.
Note: This method can return a maximum of 10,000 items in one results set.
Min: 0

Max: 9,999

Default: 0' required: false schema: type: string - name: q in: query description: A string consisting of one or more keywords used to search for items on eBay.

Note: The * wildcard character is not allowed in this field.
When providing two or more keywords in a single query, the string is processed as follows:
Note: When specifying keywords using the q parameter, do not include an epid or gtin parameter value as neither can be used in conjuction with a keyword search. required: false schema: type: string - name: sort in: query description: 'Specifies the criteria on which returned items are to be sorted.

Items can be sorted in ascending order based on:
The following is an example of using the value of the ItemID field for a specific item to get the RESTful itemId value.
browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9
required: true schema: type: string - name: legacy_variation_id in: query description: 'This query parameter specifies the legacy item ID of a specific item in a multi-variation listing, such as that for the red shirt size L item.

Important! A legacy_item_id value must always be passed in when specifying a legacy_variation_id value.

' required: false schema: type: string - name: legacy_variation_sku in: query description: 'This query parameter specifies the legacy SKU of an item. SKUs are the unique identifiers of an item created by the seller.

The following is an example of using the value of the ItemID and SKU fields to get the RESTful itemId value.
browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&legacy_variation_sku=V**********M

Important! A legacy_item_id value must always be passed in when specifying a legacy_variation_sku value.

' required: false schema: type: string - name: X-EBAY-C-ENDUSERCTX in: header description: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.

For additional information, refer to Use request headers in the Buying Integration Guide. required: false schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.
See MarketplaceIdEnum for a list of supported marketplaces. required: false schema: type: string - name: Accept-Language in: header description: This header is used to indicate the natural language and locale preferred by the user for the response.

This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example: required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Item' x-response-codes: errors: '11502': domain: API_BROWSE category: APPLICATION description: There was a problem extracting product information for this Item. Please try again. '11508': domain: API_BROWSE category: APPLICATION description: This seller is currently away. If you make a purchase, please allow additional time for your order to be processed. '11509': domain: API_BROWSE category: APPLICATION description: This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed. '400': description: Bad Request x-response-codes: errors: '11003': domain: API_BROWSE category: REQUEST description: The specified legacy item ID was not found. '11004': domain: API_BROWSE category: REQUEST description: The item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again. '11006': domain: API_BROWSE category: REQUEST description: The legacy ID is invalid. Use {itemGroupHref} to get the item group details. '11009': domain: API_BROWSE category: REQUEST description: The legacy variation sku is invalid. '11010': domain: API_BROWSE category: REQUEST description: You cannot submit legacy_variation_sku and legacy_variation_id in the same request. For help, see the documentation. '11011': domain: API_BROWSE category: REQUEST description: 'The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}' '11501': domain: API_BROWSE category: REQUEST description: 'The ''fieldgroups'' value(s) are invalid: {fieldgroups}. The supported fieldgroups are: {supportedFieldgroups}' '404': description: Not Found '409': description: Conflict '500': description: Internal Server Error x-response-codes: errors: '11000': domain: API_BROWSE category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope /item/: get: tags: - item description: 'This method retrieves the details about specific items that buyers need to make a purchasing decision.

Note: This is a Limited Release(Limited Release) available only to select Partners.

For this method, only the following fields are returned: bidCount, currentBidPrice, eligibleForInlineCheckout, enabledForGuestCheckout, estimatedAvailabilities, gtin, itemAffiliateWebUrl, itemCreationDate, itemId, itemWebUrl, legacyItemId, minimumPriceToBid, price, priorityListing, reservePriceMet, sellerItemRevision, taxes, topRatedBuyingExperience, and uniqueBidderCount.

The array shippingOptions, which comprises multiple fields, is also returned.

Restrictions

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

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.' operationId: getItems parameters: - name: item_ids in: query description: 'A comma separated list of the unique identifiers of the items to retrieve (maximum 20).

Note: In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.
RESTful Item ID Format: v1|#|#

For a single SKU listing, pass in the item ID:
v1|2**********2|0
For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2

For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide.' required: false schema: type: string - name: item_group_ids in: query description: A comma separated list of the unique identifiers of the item groups being retrieved (maximum 10).

Note: In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.
RESTful Group Item ID Format: ############

For example:
3**********9
required: false schema: type: string - name: X-EBAY-C-ENDUSERCTX in: header description: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.

For additional information, refer to Use request headers in the Buying Integration Guide. required: false schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.
See MarketplaceIdEnum for a list of supported marketplaces. required: false schema: type: string - name: Accept-Language in: header description: This header is used to indicate the natural language and locale preferred by the user for the response.

This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example: required: false schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Items' x-response-codes: errors: '11502': domain: API_BROWSE category: APPLICATION description: There was a problem extracting product information for this item. Please try again. '11508': domain: API_BROWSE category: APPLICATION description: This seller is currently away. If you make a purchase, please allow additional time for your order to be processed. '11509': domain: API_BROWSE category: APPLICATION description: This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed. '400': description: Bad Request x-response-codes: errors: '11001': domain: API_BROWSE category: REQUEST description: The specified item ID was not found. '11002': domain: API_BROWSE category: REQUEST description: The specified item group was not found. '11004': domain: API_BROWSE category: REQUEST description: The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again. '11005': domain: API_BROWSE category: REQUEST description: The item group ID is invalid. Use {itemHref} to get the item details. '11008': domain: API_BROWSE category: REQUEST description: The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again. '11011': domain: API_BROWSE category: REQUEST description: 'The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}' '11012': domain: API_BROWSE category: REQUEST description: The specified item IDs are invalid, or the format of the specified values are invalid. '11013': domain: API_BROWSE category: REQUEST description: The specified group IDs are invalid, or the format of the specified values are invalid. '11014': domain: API_BROWSE category: REQUEST description: An item_ids and an item_group_ids list cannot be used at same time. Please use only one of these lists. '11015': domain: API_BROWSE category: REQUEST description: The maximum number of item IDs has been exceeded. Please reduce the number of item IDs to {maxAllowedItemIds} or less. '11016': domain: API_BROWSE category: REQUEST description: The maximum number of item group IDs has been exceeded. Please reduce the number of item group ids to {maxAllowedItemGroupIds} or less. '11017': domain: API_BROWSE category: REQUEST description: An item_ids or an item_group_ids list is required. Please use one of these lists. '404': description: Not Found '409': description: Conflict '500': description: Internal Server Error x-response-codes: errors: '11000': domain: API_BROWSE category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.item.bulk /item/get_items_by_item_group: get: tags: - item description: 'This method retrieves details about individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

You pass in the item_group_id as a URI parameter.

This method returns two main containers:Setting the fieldgroup to ADDITIONAL_SELLER_DETAILS adds an additional field to the response that returns the seller''s user ID. For more information, refer to fieldgroups.

Restrictions

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

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.' operationId: getItemsByItemGroup parameters: - name: fieldgroups in: query description: This field controls what is returned in the response. If this field is not set, the method returns all details about the item.

Valid Values:

ADDITIONAL_SELLER_DETAILS - This field group adds the userId field to the response. required: false schema: type: string - name: item_group_id in: query description: This query parameter specifies the unique identifier of an item group for which information is to be returned. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

This ID is returned in the itemGroupHref field of the search and getItem methods.

For Example:
https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6
required: true schema: type: string - name: X-EBAY-C-ENDUSERCTX in: header description: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.

For additional information, refer to Use request headers in the Buying Integration Guide. required: false schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.
See MarketplaceIdEnum for a list of supported marketplaces. required: false schema: type: string - name: Accept-Language in: header description: This header is used to indicate the natural language and locale preferred by the user for the response.

This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example: required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ItemGroup' x-response-codes: errors: '11508': domain: API_BROWSE category: APPLICATION description: This seller is currently away. If you make a purchase, please allow additional time for your order to be processed. '11509': domain: API_BROWSE category: APPLICATION description: This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed. '400': description: Bad Request x-response-codes: errors: '11002': domain: API_BROWSE category: REQUEST description: The specified item group was not found. '11005': domain: API_BROWSE category: REQUEST description: Item Group Id is invalid. Use {itemHref} to get the item details. '11008': domain: API_BROWSE category: REQUEST description: The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again. '11011': domain: API_BROWSE category: REQUEST description: 'The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}' '11501': domain: API_BROWSE category: REQUEST description: 'The ''fieldgroups'' value(s) are invalid: {fieldgroups}. The supported fieldgroups are: {supportedFieldgroups}' '404': description: Not Found '409': description: Conflict '500': description: Internal Server Error x-response-codes: errors: '11000': domain: API_BROWSE category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope /item/{item_id}/check_compatibility: post: tags: - item description: 'This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay.

For example, to check the compatibility of a part, you pass in the item_id of the part as a URI parameter and specify all the attributes used to define a specific car within the compatibilityProperties container. If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. Refer to compatibilityStatus for details.

Note: The only products supported are cars, trucks, and motorcycles.
To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car.

For more information and a list of required attributes for the US marketplace that describe motor vehicles, refer to Check compatibility in the Buying Integration Guide.

For an example, refer to the Samples section.

Note: This method is supported in Sandbox but only when passing in the specified item_id and compatibility name-value pairs listed in Sample 2: Sandbox Sample.

Restrictions

For a list of supported sites and other restrictions, refer to API Restrictions.' operationId: checkCompatibility parameters: - name: item_id in: path description: 'This path parameter specifies the unique RESTful identifier of an item (such as the park you want to check).

RESTful Item ID Format: v1|#|#

For a single SKU listing, pass in the item ID:
v1|2**********2|0
For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2

For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide.' required: true schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.
See MarketplaceIdEnum for supported values. required: false schema: type: string - name: Content-Type in: header description: This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide. required: true schema: type: string - name: Accept-Language in: header description: This header is used to indicate the natural language and locale preferred by the user for the response.

This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example: required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CompatibilityPayload' required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CompatibilityResponse' x-response-codes: errors: '11504': domain: API_BROWSE category: REQUEST description: 'The following compatibilityProperties (attributes name/value pairs) are missing: {attributes}' '400': description: Bad Request x-response-codes: errors: '11001': domain: API_BROWSE category: REQUEST description: The specified item ID was not found. '11011': domain: API_BROWSE category: REQUEST description: 'The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}' '11503': domain: API_BROWSE category: REQUEST description: The request is either empty or incomplete. For help, see the documentation for this call. '11505': domain: API_BROWSE category: REQUEST description: The item is not valid for compatibility validation. '11506': domain: API_BROWSE category: REQUEST description: The 'name' {compatibilityNames} appears more than once in the request. '11507': domain: API_BROWSE category: REQUEST description: The following name(s) in the request are not supported {attributes}. '404': description: Not Found '409': description: Conflict '500': description: Internal Server Error x-response-codes: errors: '11000': domain: API_BROWSE category: APPLICATION description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. security: - api_auth: - https://api.ebay.com/oauth/api_scope components: schemas: AdditionalProductIdentity: type: object properties: productIdentity: type: array description: An array of product identifier/value pairs for the product associated with the item. This is returned if the seller has associated the eBay Product Identifier (ePID) with the item and the request has fieldgroups set to PRODUCT.

The following table shows what is returned, based on the item information provided by the seller, when fieldgroups is set to PRODUCT.

ePID ProvidedProduct ID(s) ProvidedResponse
NoNoThe AdditionalProductIdentity container is not returned.
NoYesThe AdditionalProductIdentity container is not returned but the product identifiers specified by the seller are returned in the localizedAspects container.
YesNoThe AdditionalProductIdentity container is returned listing the product identifiers of the product.
YesYesThe AdditionalProductIdentity container is returned listing all the product identifiers of the product and the product identifiers specified by the seller are returned in the localizedAspects container.
items: $ref: '#/components/schemas/ProductIdentity' description: The type that defines the array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item, and in the request fieldgroups is set to PRODUCT. AddonService: type: object properties: selection: type: string description: This field indicates whether the add-on service must be selected for the item. For implementation help, refer to eBay API documentation serviceFee: description: The amount charged for the add-on service. $ref: '#/components/schemas/ConvertedAmount' serviceId: type: string description: The ID number of the add-on service. serviceType: type: string description: The type of add-on service, such as AUTHENTICITY_GUARANTEE. For implementation help, refer to eBay API documentation description: This container describes an add-on service that may be selected for an item or that may apply automatically. A charge may be associated with the add-on service. Address: type: object properties: addressLine1: type: string description: The first line of the street address.

Note: This is conditionally returned in the itemLocation field. addressLine2: type: string description: The second line of the street address. This field is not always used, but can be used for "Suite Number" or "Apt Number". city: type: string description: The city of the address. country: type: string description: The two-letter ISO 3166 standard code for the country of the address. For implementation help, refer to eBay API documentation county: type: string description: The county of the address. postalCode: type: string description: The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API. stateOrProvince: type: string description: The state or province of the address.

Note: This is conditionally returned in the itemLocation field. description: The type that defines the fields for an address. Amount: type: object properties: currency: type: string description: 'The list of valid currencies. Each ISO 4217 currency code includes the currency name followed by the numeric value.

For example, the Canadian Dollar code (CAD) would take the following form: Canadian Dollar, 124. For implementation help, refer to eBay API documentation' value: type: string description: The value of the discounted amount. Aspect: type: object properties: localizedName: type: string description: The text representing the name of the aspect for the name/value pair, such as Brand. localizedValues: type: array description: The text representing the value of the aspect for the name/value pair, such as Apple. items: type: string description: 'The type that defines the fields for the name/value pairs for the aspects of the product. For example: BRAND/Apple' AspectDistribution: type: object properties: aspectValueDistributions: type: array description: An array of containers for the various values of the aspect and the match count, and a HATEOAS reference (refinementHref) for this aspect. items: $ref: '#/components/schemas/AspectValueDistribution' localizedAspectName: type: string description: The name of an aspect, such as Brand, Color, etc. description: The type that define the fields for the aspect information. Aspects are the variations of an item, such as color, size, etc. AspectGroup: type: object properties: aspects: type: array description: 'An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple' items: $ref: '#/components/schemas/Aspect' localizedGroupName: type: string description: The name of a group of aspects.

In the following example, Product Identifiers and Process are product aspect group names. Under the group name are the product aspect name/value pairs.

Product Identifiers
   Brand/Apple
   Product Family/iMac

Processor
   Processor Type/Intel
   Processor Speed/3.10 AspectValueDistribution: type: object properties: localizedAspectValue: type: string description: The value of an aspect. For example, Red is a value for the aspect Color. matchCount: type: integer description: The number of items with this aspect. format: int32 refinementHref: type: string description: A HATEOAS reference for this aspect. description: The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to ASPECT_REFINEMENTS or FULL in the request. AttributeNameValue: type: object properties: name: type: string description: The name of the product attribute, such as Make, Model, Year, etc. value: type: string description: The value for the name attribute, such as BMW, R1200GS, 2011, etc. description: The type the defines attribute name/value pair fields that specify a product. The type of data depends on the context. For example, if you were using this to specify a specific vehicle, the attribute names would be Make, Model, Year, etc. AuthenticityGuaranteeProgram: type: object properties: description: type: string description: An indication that the item is qualified for the Authenticity Guarantee program. termsWebUrl: type: string description: The URL to the Authenticity Guarantee program terms of use. description: A type that identifies whether the item is qualified for the Authenticity Guarantee program. AuthenticityVerificationProgram: type: object properties: description: type: string description: An indication that the item is from a verified seller. termsWebUrl: type: string description: The URL to the Authenticity Verification program terms of use. description: A type that identifies whether the item is from a verified seller. AutoCorrections: type: object properties: q: type: string description: The automatically spell-corrected keyword from the request. AvailableCoupon: type: object properties: constraint: description: The limitations or restrictions of the coupon. $ref: '#/components/schemas/CouponConstraint' discountAmount: description: The discount amount after the coupon is applied. $ref: '#/components/schemas/Amount' discountType: type: string description: The type of discount that the coupon applies. For implementation help, refer to eBay API documentation message: type: string description: A description of the coupon.

Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response. redemptionCode: type: string description: The coupon code. termsWebUrl: type: string description: The URL to the coupon terms of use.

Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response. BuyingOptionDistribution: type: object properties: buyingOption: type: string description: The container that returns the buying option type. This will be AUCTION, FIXED_PRICE, CLASSIFIED_AD, or a combination of these options. For details, see buyingOptions. matchCount: type: integer description: The number of items having this buying option. format: int32 refinementHref: type: string description: The HATEOAS reference for this buying option. description: The container that defines the fields for the buying options refinements. This container is returned when fieldgroups is set to BUYING_OPTION_REFINEMENTS or FULL in the request. Category: type: object properties: categoryId: type: string description: The unique identifier of the category. categoryName: type: string description: The name of the category. description: This type is used by the categories container in the response of the search method, and contains the name and ID of the item category. CategoryDistribution: type: object properties: categoryId: type: string description: The unique identifier of the category. categoryName: type: string description: The name of the category, such as Baby & Toddler Clothing. matchCount: type: integer description: The number of items in this category. format: int32 refinementHref: type: string description: The HATEOAS reference of this category. description: The container that defines the fields for the category refinements. This container is returned when fieldgroups is set to CATEGORY_REFINEMENTS or FULL in the request. CommonDescriptions: type: object properties: description: type: string description: The item description that is used by more than one of the item variations. itemIds: type: array description: A list of item ids that have this description. items: type: string description: The type that defines the fields for the item_id values that all use a common description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the items.description field. CompatibilityPayload: type: object properties: compatibilityProperties: type: array description: 'An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be

"name" : "Year",
"value" : "2019"


For a list of the attributes required for cars and trucks and motorcycles see Check compatibility in the Buy Integration Guide.' items: $ref: '#/components/schemas/AttributeNameValue' description: 'An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be:

"name" : "Year",
"value" : "2019"


For a list of the attributes required for cars and trucks and motorcycles refer to Check compatibility in the Buying Integration Guide.' CompatibilityProperty: type: object properties: localizedName: type: string description: The name of the product attribute that as been translated to the language of the site. name: type: string description: The name of the product attribute, such as Make, Model, Year, etc. value: type: string description: The value for the name attribute, such as BMW, R1200GS, 2011, etc. description: This container returns the product attribute name/value pairs that are compatible with the keyword. These attributes are submitted in the compatibility_filter request field. CompatibilityResponse: type: object properties: compatibilityStatus: type: string description: 'An enumeration value that tells you if the item is compatible with the product.

The values are: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' warnings: type: array description: An array of warning messages. These types of errors do not prevent the method from executing but should be checked. items: $ref: '#/components/schemas/Error' description: 'The type that defines the response fields for checkCompatibility. ' ConditionDescriptor: type: object properties: name: type: string description: The name of a condition descriptor. The value(s) for this condition descriptor is returned in the associated values array. values: type: array description: This array displays the value(s) for a condition descriptor (denoted by the associated name field), as well as any other additional information about the condition of the item. items: $ref: '#/components/schemas/ConditionDescriptorValue' description: This type displays additional information about the condition of an item in a structured format. ConditionDescriptorValue: type: object properties: additionalInfo: type: array description: Additional information about the condition of an item as it relates to a condition descriptor. This array elaborates on the value specified in the content field and provides additional details about the condition of an item. items: type: string content: type: string description: The value for the condition descriptor indicated in the associated name field. description: 'This type displays the value(s) associated with the specified condition descriptor name, as well as any additional information about a condition descriptor. ' ConditionDistribution: type: object properties: condition: type: string description: The text describing the condition of the item, such as New or Used. For a list of condition names, refer to Item Condition IDs and Names. conditionId: type: string description: The identifier of the condition. For example, 1000 is the identifier for NEW. matchCount: type: integer description: The number of items having the condition. format: int32 refinementHref: type: string description: The HATEOAS reference of this condition. description: The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to CONDITION_REFINEMENTS or FULL in the request. ConvertedAmount: type: object properties: convertedFromCurrency: type: string description: The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to eBay API documentation convertedFromValue: type: string description: The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field. currency: type: string description: The three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country. For implementation help, refer to eBay API documentation value: type: string description: The monetary amount in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency. description: This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable. CoreItem: type: object properties: additionalImages: type: array description: An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field. items: $ref: '#/components/schemas/Image' adultOnly: type: boolean description: This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers. ageGroup: type: string description: (Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container. authenticityGuarantee: description: 'A container for information about whether an item is qualified for the Authenticity Guarantee program.

Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.

Note: Refer to the Authenticity Guarantee page for more information.' $ref: '#/components/schemas/AuthenticityGuaranteeProgram' authenticityVerification: description: A container for information about whether an item is from a verified seller.
$ref: '#/components/schemas/AuthenticityVerificationProgram' availableCoupons: type: array description: A list of available coupons for the item. items: $ref: '#/components/schemas/AvailableCoupon' bidCount: type: integer description: This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items. format: int32 brand: type: string description: (Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container. buyingOptions: type: array description: A comma separated list of all the purchase options available for the item. The values returned are:Code so that your app gracefully handles any future changes to this list. items: type: string categoryId: type: string description: The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children. categoryPath: type: string description: 'Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks' color: type: string description: (Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container. condition: type: string description: A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.

Code so that your app gracefully handles any future changes to this list. conditionDescription: type: string description: A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item. conditionId: type: string description: 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. currentBidPrice: description: The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items. $ref: '#/components/schemas/ConvertedAmount' description: type: string description: The full description of the item that was created by the seller. This can be plain text or rich content and can be very large. eligibleForInlineCheckout: type: boolean description: This field indicates if the item can be purchased using the Buy Order API. enabledForGuestCheckout: type: boolean description: This indicates if the item can be purchased using Guest Checkout in the Order API. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards. energyEfficiencyClass: type: string description: This 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.

When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field. epid: type: string description: An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. estimatedAvailabilities: type: array description: 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. items: $ref: '#/components/schemas/EstimatedAvailability' gender: type: string description: '(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.' gtin: type: string description: 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. image: description: The URL of the primary image of the item. The other images of the item are returned in the additionalImages container. $ref: '#/components/schemas/Image' inferredEpid: type: string description: 'The ePID (eBay Product ID of a product from 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 provided an ePID for the item, the seller''s value is returned in the epid field.

Note: This field is returned only for authorized Partners.' itemAffiliateWebUrl: type: string description: The URL to the View Item page of the item which includes the affiliate tracking ID.

Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The itemAffiliateWebUrl is only returned if: itemCreationDate: type: string description: A timestamp that indicates the date and time an item listing was created.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer. itemEndDate: type: string description: 'This timestamp indicates the date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: This field is only returned for auction listings.' itemId: type: string description: The unique RESTful identifier of the item. itemLocation: description: The physical location of the item. $ref: '#/components/schemas/Address' itemWebUrl: type: string description: The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. 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. localizedAspects: type: array description: An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item. items: $ref: '#/components/schemas/TypedNameValue' lotSize: type: integer description: '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. ' format: int32 marketingPrice: description: The original price and the discount amount and percentage. $ref: '#/components/schemas/MarketingPrice' material: type: string description: (Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container. minimumPriceToBid: description: The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding. $ref: '#/components/schemas/ConvertedAmount' mpn: type: string description: The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand. pattern: type: string description: (Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container. paymentMethods: type: array description: The payment methods for the item, including the payment method types, brands, and instructions for the buyer. items: $ref: '#/components/schemas/PaymentMethod' price: description: 'The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.

Note: The price does include 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.' $ref: '#/components/schemas/ConvertedAmount' priceDisplayCondition: type: string description: Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to eBay API documentation primaryItemGroup: description: 'The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

Note: This container is returned if the item_id in the request is for an item group (items with variations, such as color and size). This container is also returned on a request for item_group_ids.' $ref: '#/components/schemas/ItemGroupSummary' primaryProductReviewRating: description: The container that returns the product rating details, such as review count, rating histogram, and average rating. $ref: '#/components/schemas/ReviewRating' priorityListing: type: boolean description: This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.

For more information, see Promoted Listings. product: description: The container that returns the product information of the item. $ref: '#/components/schemas/Product' productFicheWebUrl: type: string description: The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field. qualifiedPrograms: type: array description: 'An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.

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.' items: type: string quantityLimitPerBuyer: type: integer description: The maximum number for a specific item that one buyer can purchase. format: int32 reservePriceMet: type: boolean description: 'This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for.

If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.

Note: This is returned only for auctions that have a reserve price.

' returnTerms: description: The container that returns an overview of the seller's return policy. $ref: '#/components/schemas/ItemReturnTerms' seller: description: The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information. $ref: '#/components/schemas/SellerDetail' sellerItemRevision: type: string description: 'An identifier generated/incremented when a seller revises the item. There are two types of item revisions: This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.' shippingOptions: type: array description: 'An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. ' items: $ref: '#/components/schemas/ShippingOption' shipToLocations: description: The container that returns the geographic regions to be included and excluded that define where the item can be shipped. $ref: '#/components/schemas/ShipToLocations' shortDescription: type: string description: This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). size: type: string description: (Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container. sizeSystem: type: string description: '(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.

Valid Values:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)

Code so that your app gracefully handles any future changes to this list. ' sizeType: type: string description: (Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container. subtitle: type: string description: A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results. taxes: type: array description: The container for the tax information for the item. items: $ref: '#/components/schemas/Taxes' title: type: string description: 'The seller-created title of the item.

Maximum Length: 80 characters' topRatedBuyingExperience: type: boolean description: 'This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information.' tyreLabelImageUrl: type: string description: The URL to the image that shows the information on the tyre label. uniqueBidderCount: type: integer description: This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items. format: int32 unitPrice: description: '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"
' $ref: '#/components/schemas/ConvertedAmount' 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.

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

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
' description: An array of containers with the details for all of the items returned. CouponConstraint: type: object properties: expirationDate: type: string description: This timestamp provides the expiration date of the coded coupon. description: This type is used to provide the expiration date of a coded coupon. EconomicOperator: type: object properties: companyName: type: string description: The company name of the registered Economic Operator. addressLine1: type: string description: The first line of the registered Economic Operator's street address. addressLine2: type: string description: The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. city: type: string description: The city of the registered Economic Operator's street address. stateOrProvince: type: string description: The state or province of the registered Economic Operator's street address. postalCode: type: string description: The postal code of the registered Economic Operator's street address. country: type: string description: The two-letter ISO 3166 standard abbreviation of the country of the registered Economic Operator's address. phone: type: string description: The registered Economic Operator's business phone number. email: type: string description: The registered Economic Operator's business email address. description: The type that provides required Economic Operator information about the manufacturer and/or supplier of the item. Error: type: object properties: category: type: string description: 'This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.' domain: type: string description: The name of the primary system where the error occurred. This is relevant for application errors. errorId: type: integer description: A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. format: int32 inputRefIds: type: array description: An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. items: type: string longMessage: type: string description: A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. message: type: string description: A description of the condition that caused the error or warning. outputRefIds: type: array description: An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. items: type: string parameters: type: array description: An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning. items: $ref: '#/components/schemas/ErrorParameter' subdomain: type: string description: The name of the subdomain in which the error or warning occurred. description: The type that defines the fields that can be returned in an error. ErrorParameter: type: object properties: name: type: string description: This is the name of input field that caused an issue with the call request. value: type: string description: This is the actual value that was passed in for the element specified in the name field. description: An array of name/value pairs that provide details regarding the error. EstimatedAvailability: type: object properties: availabilityThreshold: type: integer description: This field is return 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 field will be "10", which is the threshold value.

Code so that your app gracefully handles any future changes to this value. format: int32 availabilityThresholdType: type: string description: ' This field is return 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 field will be MORE_THAN. This indicates that the seller has more than the ''quantity display preference'', which is 10, in stock for this item.

The following are the display item quantity preferences the seller can set.

Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to eBay API documentation' deliveryOptions: type: array description: 'An array of available delivery options.

Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY

Code so that your app gracefully handles any future changes to this list. ' items: type: string description: ' For implementation help, refer to eBay API documentation' estimatedAvailabilityStatus: type: string description: 'An enumeration value representing the inventory status of this item.

Note: Be sure to review the itemEndDate field to determine whether the item is available for purchase.

Valid Values: IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' estimatedAvailableQuantity: type: integer description: 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. format: int32 estimatedSoldQuantity: type: integer description: The estimated number of this item that have been sold. format: int32 description: The type that defines the fields for the estimated item availability information. HazardPictogram: type: object properties: pictogramDescription: type: string description: The description of the hazard pictogram, such as Flammable. pictogramId: type: string description: The ID of the hazard pictogram. pictogramUrl: type: string description: The URL of the hazard pictogram. description: A type that defines the pictogram for the type of hazard that a hazardous material represents. HazardStatement: type: object properties: statementDescription: type: string description: A description of the nature of the hazard, such as whether the material is toxic if swallowed. statementId: type: string description: The ID of the hazard statement. description: A type that defines the hazard statement for a hazardous material. HazardousMaterialsLabels: type: object properties: additionalInformation: type: string description: Additional information about the hazardous materials labels. pictograms: type: array description: An array of hazard pictograms that apply to the item. items: $ref: '#/components/schemas/HazardPictogram' signalWord: type: string description: The signal word for the hazardous materials label (such as Danger or Warning). signalWordId: type: string description: The ID of the signal word for the hazardous materials label. statements: type: array description: An array of hazard statements for the item. items: $ref: '#/components/schemas/HazardStatement' description: A type that defines the hazardous materials labels for an item. Image: type: object properties: height: type: integer description: Reserved for future use. format: int32 imageUrl: type: string description: The URL of the image. width: type: integer description: Reserved for future use. format: int32 description: Type that defines the details of an image, such as size and image URL. Currently, only imageUrl is populated. The height and width are reserved for future use. Item: type: object properties: additionalImages: type: array description: An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field. items: $ref: '#/components/schemas/Image' addonServices: type: array description: A list of add-on services that may be selected for the item or that may apply automatically. items: $ref: '#/components/schemas/AddonService' adultOnly: type: boolean description: This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers. ageGroup: type: string description: (Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container. authenticityGuarantee: description: 'A container for information about whether an item, or the item group when returned for the getItemsByItemGroup method, is qualified for the Authenticity Guarantee program.

Note: The AUTHENTICITY_GUARANTEE value being returned by the getItemsByItemGroup method indicates that at least one item in the item group supports this program, but doesn''t guarantee that the program is available to all items in the item group. To verify if the Authenticity Program is indeed available for the item that you are interested in, grab the items.itemId value for that item and use the getItem method. This method will return specific details on that particular item, including whether or not the Authenticity Guarantee Program is available for the item. Look for the qualifiedPrograms array and authenticityGuarantee container in the getItem response for this information.

Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.

Note: Refer to the Authenticity Guarantee page for more information.' $ref: '#/components/schemas/AuthenticityGuaranteeProgram' authenticityVerification: description: A container for information about whether an item is from a verified seller. $ref: '#/components/schemas/AuthenticityVerificationProgram' availableCoupons: type: array description: A list of available coupons for the item. items: $ref: '#/components/schemas/AvailableCoupon' bidCount: type: integer description: This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items. format: int32 brand: type: string description: (Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container. buyingOptions: type: array description: A comma separated list of all the purchase options available for the item. The values returned are:Code so that your app gracefully handles any future changes to this list. items: type: string categoryId: type: string description: The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children. categoryIdPath: type: string description: 'The IDs of every category in the item path, separated by pipe characters, starting with the top level parent category.

For example, if an item belongs to the top level category Home and Garden (category ID 11700), followed by Home Improvement (159907), Heating, Cooling and Air (69197), and Thermostats (115947), the field would return the value: 11700|159907|69197|115947.' categoryPath: type: string description: 'Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks' color: type: string description: (Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container. condition: type: string description: A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.

Code so that your app gracefully handles any future changes to this list. conditionDescription: type: string description: A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item. conditionDescriptors: type: array description: This array is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that indicate details about a particular condition of an item.

Note: Condition descriptors are currently only available for the following trading card categories: items: $ref: '#/components/schemas/ConditionDescriptor' conditionId: type: string description: 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. currentBidPrice: description: The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items. $ref: '#/components/schemas/ConvertedAmount' description: type: string description: The full description of the item that was created by the seller. This can be plain text or rich content and can be very large. ecoParticipationFee: description: The Eco Participation fee, a fee paid by the buyer that is applied to the cost of the eventual disposal of the purchased item. The fee is remitted in full to the eco organization.

Currently, this value is required for electronic devices and furniture. $ref: '#/components/schemas/ConvertedAmount' eligibleForInlineCheckout: type: boolean description: This field indicates if the item can be purchased using the Buy Order API. enabledForGuestCheckout: type: boolean description: This indicates if the item can be purchased using Guest Checkout in the Order API. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards. energyEfficiencyClass: type: string description: This 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.

When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field. epid: type: string description: An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. estimatedAvailabilities: type: array description: 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. items: $ref: '#/components/schemas/EstimatedAvailability' gender: type: string description: '(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.' gtin: type: string description: 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. hazardousMaterialsLabels: description: Hazardous materials labels for the item. $ref: '#/components/schemas/HazardousMaterialsLabels' image: description: The URL of the primary image of the item. The other images of the item are returned in the additionalImages container. $ref: '#/components/schemas/Image' inferredEpid: type: string description: 'The ePID (eBay Product ID of a product from 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 provided an ePID for the item, the seller''s value is returned in the epid field.

Note: This field is returned only for authorized Partners.' itemAffiliateWebUrl: type: string description: The URL to the View Item page of the item which includes the affiliate tracking ID.

Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The itemAffiliateWebUrl is only returned if: itemCreationDate: type: string description: A timestamp that indicates the date and time an item listing was created.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer. itemEndDate: type: string description: 'This timestamp indicates the date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: This field is only returned for auction listings.' itemId: type: string description: The unique RESTful identifier of the item. itemLocation: description: The physical location of the item. $ref: '#/components/schemas/Address' itemWebUrl: type: string description: The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. 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. listingMarketplaceId: type: string description: The ID of the eBay marketplace where the item is listed. For implementation help, refer to eBay API documentation localizedAspects: type: array description: An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item. items: $ref: '#/components/schemas/TypedNameValue' lotSize: type: integer description: '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. ' format: int32 marketingPrice: description: The original price and the discount amount and percentage. $ref: '#/components/schemas/MarketingPrice' material: type: string description: (Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container. minimumPriceToBid: description: The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding. $ref: '#/components/schemas/ConvertedAmount' mpn: type: string description: The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand. pattern: type: string description: (Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container. paymentMethods: type: array description: The payment methods for the item, including the payment method types, brands, and instructions for the buyer. items: $ref: '#/components/schemas/PaymentMethod' price: description: 'The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.

Note: The price does include 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.' $ref: '#/components/schemas/ConvertedAmount' priceDisplayCondition: type: string description: Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to eBay API documentation primaryItemGroup: description: 'The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

Note: This container is returned only if the item_id in the request is for an item group (items with variations, such as color and size).' $ref: '#/components/schemas/ItemGroupSummary' primaryProductReviewRating: description: The container that returns the product rating details, such as review count, rating histogram, and average rating. $ref: '#/components/schemas/ReviewRating' priorityListing: type: boolean description: This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.

For more information, see Promoted Listings. product: description: The container that returns the product information of the item. $ref: '#/components/schemas/Product' productFicheWebUrl: type: string description: The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field. qualifiedPrograms: type: array description: 'An array of the qualified programs available for the item, or for the item group when returned for the getItemsByItemGroup method, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.

Note: The AUTHENTICITY_GUARANTEE value being returned by the getItemsByItemGroup method indicates that at least one item in the item group supports this program, but doesn''t guarantee that the program is available to all items in the item group. To verify if the Authenticity Program is indeed available for the item that you are interested in, grab the items.itemId value for that item and use the getItem method. This method will return specific details on that particular item, including whether or not the Authenticity Guarantee Program is available for the item. Look for the qualifiedPrograms array and authenticityGuarantee container in the getItem response for this information.

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.' items: type: string quantityLimitPerBuyer: type: integer description: The maximum number for a specific item that one buyer can purchase. format: int32 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. reservePriceMet: type: boolean description: 'This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for.

If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.

Note: This is returned only for auctions that have a reserve price.

' returnTerms: description: The container that returns an overview of the seller's return policy. $ref: '#/components/schemas/ItemReturnTerms' seller: description: The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information. $ref: '#/components/schemas/SellerDetail' sellerCustomPolicies: type: array description: A list of the custom policies that are applied to a listing. items: $ref: '#/components/schemas/SellerCustomPolicy' sellerItemRevision: type: string description: 'An identifier generated/incremented when a seller revises the item. There are two types of item revisions: This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.' shippingOptions: type: array description: 'An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. ' items: $ref: '#/components/schemas/ShippingOption' shipToLocations: description: The container that returns the geographic regions to be included and excluded that define where the item can be shipped. $ref: '#/components/schemas/ShipToLocations' shortDescription: type: string description: This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). size: type: string description: (Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container. sizeSystem: type: string description: '(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.

Valid Values:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)

Code so that your app gracefully handles any future changes to this list. ' sizeType: type: string description: (Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container. subtitle: type: string description: A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results. taxes: type: array description: The container for the tax information for the item. items: $ref: '#/components/schemas/Taxes' title: type: string description: 'The seller-created title of the item.

Maximum Length: 80 characters' topRatedBuyingExperience: type: boolean description: 'This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information.' tyreLabelImageUrl: type: string description: The URL to the image that shows the information on the tyre label. uniqueBidderCount: type: integer description: This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items. format: int32 unitPrice: description: '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"
' $ref: '#/components/schemas/ConvertedAmount' 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.

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

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
' warnings: type: array description: An array of warning messages. These types of errors do not prevent the method from executing but should be checked. items: $ref: '#/components/schemas/Error' watchCount: type: integer description: The number of users that have added the item to their watch list.

Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API. format: int32 description: The details of an item that can be purchased. ItemGroup: type: object properties: commonDescriptions: type: array description: An array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the items.description field. items: $ref: '#/components/schemas/CommonDescriptions' items: type: array description: An array of containers for all the item variation details, excluding the description. items: $ref: '#/components/schemas/Item' warnings: type: array description: An array of warning messages. These types of errors do not prevent the method from executing but should be checked. items: $ref: '#/components/schemas/Error' description: The type that defines the fields for the item details. ItemGroupSummary: type: object properties: itemGroupAdditionalImages: type: array description: An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field. items: $ref: '#/components/schemas/Image' itemGroupHref: type: string description: 'The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ' itemGroupId: type: string description: 'The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ' itemGroupImage: description: 'The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ' $ref: '#/components/schemas/Image' itemGroupTitle: type: string description: 'The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ' itemGroupType: type: string description: An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. For implementation help, refer to eBay API documentation description: 'The type that defines the fields for the details of each item in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

Note: This container is returned only if the item_id in the request is an item group (parent ID of an item with variations).' ItemLocationImpl: type: object properties: addressLine1: type: string description: The first line of the street address. addressLine2: type: string description: The second line of the street address. This field may contain such values as an apartment or suite number. city: type: string description: The city in which the item is located.

Restriction: This field is populated in the search method response only when fieldgroups = EXTENDED. country: type: string description: The two-letter ISO 3166 standard code that indicates the country in which the item is located. For implementation help, refer to eBay API documentation county: type: string description: The county in which the item is located. postalCode: type: string description: The postal code (or zip code in US) where the item is located. Sellers set a postal code for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API. stateOrProvince: type: string description: The state or province in which the item is located. description: The type that defines the fields for the location of an item, such as information typically used for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code). ItemReturnTerms: type: object properties: extendedHolidayReturnsOffered: type: boolean description: This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the returnPeriod value. refundMethod: type: string description: 'An enumeration value that indicates how a buyer is refunded when an item is returned.

Valid Values: MONEY_BACK or MERCHANDISE_CREDIT

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' restockingFeePercentage: type: string description: This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent. So, if the cost of the item was $100, and the restocking percentage was 20 percent, the buyer would be charged $20 to return that item, so instead of receiving a $100 refund, they would receive $80 due to the restocking fee. returnInstructions: type: string description: Text written by the seller describing what the buyer needs to do in order to return the item. returnMethod: type: string description: 'An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund.

Valid Values: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' returnPeriod: description: The amount of time the buyer has to return the item after the purchase date. $ref: '#/components/schemas/TimeDuration' returnsAccepted: type: boolean description: Indicates whether the seller accepts returns for the item. returnShippingCostPayer: type: string description: 'This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned.

Valid Values: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' description: The type that defines the fields for the seller's return policy. ItemSummary: type: object properties: additionalImages: type: array description: An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field. items: $ref: '#/components/schemas/Image' adultOnly: type: boolean description: This indicates if the item is for adults only. For more information about adult-only items on eBay, refer to the Adult items policy. availableCoupons: type: boolean description: This boolean attribute indicates if coupons are available for the item. bidCount: type: integer description: This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items. format: int32 buyingOptions: type: array description: A comma separated list of all the purchase options available for the item.

Values Returned: items: type: string categories: type: array description: This array returns the name and ID of each category associated with the item, including top level, branch, and leaf categories. items: $ref: '#/components/schemas/Category' compatibilityMatch: type: string description: This indicates how well an item matches the compatibility_filter product attributes.

Valid Values: For implementation help, refer to eBay API documentation compatibilityProperties: type: array description: This container returns only the product attributes that are compatible with the item. These attributes were specified in the compatibility_filter in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned. items: $ref: '#/components/schemas/CompatibilityProperty' condition: type: string description: The text describing the condition of the item, such as New or Used. For a list of condition names, refer to Item Condition IDs and Names. conditionId: type: string description: The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, refer to Item Condition IDs and Names. currentBidPrice: description: This container returns the current highest bid for an auction item. The value field shows the dollar value of the current highest bid, and the currency field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items. $ref: '#/components/schemas/ConvertedAmount' distanceFromPickupLocation: description: This container returns the distance away that the item is from the pickupPostalCode value that was supplied in the method request. This container is only returned if the "local pickup" filter fields are used in the request. $ref: '#/components/schemas/TargetLocation' energyEfficiencyClass: type: string description: This indicates the European energy efficiency rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only.

Currently, this field is only applicable for the Germany site, and is returned only if the seller specifies the energy efficiency rating through item specifics at listing time. Rating values include A+++, A++, A+, A, B, C, D, E, F, and G. epid: type: string description: An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs. image: description: The URL to the primary image of the item. $ref: '#/components/schemas/Image' itemAffiliateWebUrl: type: string description: The URL to the View Item page of the item which includes the affiliate tracking ID.

Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The itemAffiliateWebUrl is returned only if: itemCreationDate: type: string description: The date and time when the item listing was created. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. itemEndDate: type: string description: The date and time up to which the item can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: This field is not returned for Good 'Til Cancelled (GTC) listings. itemGroupHref: type: string description: The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Note: This field is returned only for item groups. itemGroupType: type: string description: The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Currently only the SELLER_DEFINED_VARIATIONS is supported and indicates this is an item group created by the seller.

Note: This field is returned only for item groups. itemHref: type: string description: The URI for the Browse API getItem method, which can be used to retrieve more details about items in the search results. itemId: type: string description: The unique RESTful identifier of the item. itemLocation: description: This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code). $ref: '#/components/schemas/ItemLocationImpl' itemWebUrl: type: string description: The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. leafCategoryIds: type: array description: The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary. items: type: string 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. listingMarketplaceId: type: string description: The ID of the eBay marketplace on which the seller listed the item. For implementation help, refer to eBay API documentation marketingPrice: description: This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage. $ref: '#/components/schemas/MarketingPrice' pickupOptions: type: array description: This container returns the local pickup options available to the buyer. This container is returned only if the user is searching for local pickup items and set the local pickup filters in the method request. items: $ref: '#/components/schemas/PickupOptionSummary' price: description: The price of the item after it has been converted into another currency.

The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to view VAT-inclusive pricing:Note: For more information on VAT, refer to Your VAT Obligations in the UK & EU. $ref: '#/components/schemas/ConvertedAmount' priceDisplayCondition: type: string description: Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. For implementation help, refer to eBay API documentation priorityListing: type: boolean description: This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.

Note: Priority Listing is returned only with a Best Match sort and will not be returned for other sort options. qualifiedPrograms: type: array description: 'An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.

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 the 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.' items: type: string seller: description: This container returns basic information about the seller of the item, such as name, feedback score, etc. $ref: '#/components/schemas/Seller' shippingOptions: type: array description: This container returns the shipping options available to ship the item. items: $ref: '#/components/schemas/ShippingOptionSummary' shortDescription: type: string description: 'This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.) Sometimes the title does not provide enough information but the description is too big. Surfacing the shortDescription can often provide buyers with the additional information that could help them make a buying decision.

For example:
"title": "Petrel U42W FPV Drone RC Quadcopter w/HD Camera Live Video One Key Off / Landing",
"shortDescription": "1 U42W Quadcopter. Syma X5SW-V3 Wifi FPV RC Drone Quadcopter 2.4Ghz 6-Axis Gyro with Headless Mode. Syma X20 Pocket Drone 2.4Ghz Mini RC Quadcopter Headless Mode Altitude Hold. One Key Take Off / Landing function: allow beginner to easy to fly the drone without any skill.",

Restriction: This field is returned by the search method only when fieldgroups = EXTENDED.' thumbnailImages: type: array description: An array of thumbnail images for the item. items: $ref: '#/components/schemas/Image' title: type: string description: The seller-created title of the item.

Maximum Length: 80 characters topRatedBuyingExperience: type: boolean description: 'This indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy; shipping the item in 1 business day with tracking provided; and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings. For more information, refer to Look for Top Rated Plus Items and Seller performance overview.' tyreLabelImageUrl: type: string description: The URL to the image that shows the information on the tyre label. unitPrice: description: '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"
' $ref: '#/components/schemas/ConvertedAmount' 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.

For example, the following tells the buyer that the item is 7.99 per 100 grams.
"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
' watchCount: type: integer description: The number of users that have added the item to their watch list.

Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields indicating that you want access to Watch Count data in the Browse API. format: int32 description: The type that defines the fields for the details of a specific item. Items: type: object properties: items: type: array description: An arraylist of all the items. items: $ref: '#/components/schemas/CoreItem' total: type: integer description: The total number of items retrieved. format: int32 warnings: type: array description: An array of warning messages. These types of errors do not prevent the method from executing but should be checked. items: $ref: '#/components/schemas/Error' description: Container for a list of items. LegalAddress: type: object properties: addressLine1: type: string description: The first line of the street address. addressLine2: type: string description: The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. city: type: string description: The city of the address. country: type: string description: The two-letter ISO 3166 standard of the country of the address. For implementation help, refer to eBay API documentation countryName: type: string description: The name of the country of the address. county: type: string description: The name of the county of the address. postalCode: type: string description: The postal code of the address. stateOrProvince: type: string description: The state or province of the address. description: Type that defines the fields for the seller's address. MarketingPrice: type: object properties: discountAmount: description: This container returns the monetary amount of the seller discount. $ref: '#/components/schemas/ConvertedAmount' discountPercentage: type: string description: This field expresses the percentage of the seller discount based on the value in the originalPrice container. originalPrice: description: This container returns the monetary amount of the item without the discount. $ref: '#/components/schemas/ConvertedAmount' priceTreatment: type: string description: Indicates the pricing treatment (discount) that was applied to the price of the item.

Note: The pricing treatment affects the way and where the discounted price can be displayed. For implementation help, refer to eBay API documentation description: The type that defines the fields that describe a seller discount. PaymentMethod: type: object properties: paymentMethodType: type: string description: The payment method type, such as credit card or cash. For implementation help, refer to eBay API documentation paymentMethodBrands: type: array description: The payment method brands, including the payment method brand type and logo image. items: $ref: '#/components/schemas/PaymentMethodBrand' paymentInstructions: type: array description: The payment instructions for the buyer, such as cash in person or contact seller. items: type: string description: ' For implementation help, refer to eBay API documentation' sellerInstructions: type: array description: The seller instructions to the buyer, such as accepts credit cards or see description. items: type: string description: ' For implementation help, refer to eBay API documentation' PaymentMethodBrand: type: object properties: paymentMethodBrandType: type: string description: The payment method brand, such as Visa or PayPal. For implementation help, refer to eBay API documentation logoImage: description: 'The details of the logo image, such as the size and URL.

Note: Currently, only the imageUrl is populated.' $ref: '#/components/schemas/Image' PickupOptionSummary: type: object properties: pickupLocationType: type: string description: This container returns the local pickup options available to the buyer. Possible values are ARRANGED_LOCATION and STORE. description: The type that defines the fields for the local pickup options that are available for the item. It is used by the pickupOptions container. Product: type: object properties: additionalImages: type: array description: 'An array of containers with the URLs for the product images that are in addition to the primary image. ' items: $ref: '#/components/schemas/Image' additionalProductIdentities: type: array description: An array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request fieldgroups is set to PRODUCT. items: $ref: '#/components/schemas/AdditionalProductIdentity' aspectGroups: type: array description: An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs. items: $ref: '#/components/schemas/AspectGroup' brand: type: string description: The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number). description: type: string description: The rich description of an eBay product, which might contain HTML. gtins: type: array description: An array of all the possible GTINs values associated with the product. A GTIN is a 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. items: type: string image: description: The primary image of the product. This is often a stock photo. $ref: '#/components/schemas/Image' mpns: type: array description: An array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand. items: type: string title: type: string description: The title of the product. description: The type that defines the fields for the product information of the item. ProductIdentity: type: object properties: identifierType: type: string description: The type of product identifier, such as UPC and EAN. identifierValue: type: string description: The product identifier value. description: The type that defines the fields for the product identifier type/value pairs of product associated with an item. RatingHistogram: type: object properties: count: type: integer description: The total number of user ratings that the product has received. format: int32 rating: type: string description: This is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on. If a product had one four-star rating and one five-star rating, its average rating would be 4.5, and this is the value that would appear in this field. description: The type that defines the fields for product ratings. Only products that are in the eBay product catalog can be reviewed and rated. Refinement: type: object properties: aspectDistributions: type: array description: An array of containers for the all the aspect refinements. items: $ref: '#/components/schemas/AspectDistribution' buyingOptionDistributions: type: array description: An array of containers for the all the buying option refinements. items: $ref: '#/components/schemas/BuyingOptionDistribution' categoryDistributions: type: array description: An array of containers for the all the category refinements. items: $ref: '#/components/schemas/CategoryDistribution' conditionDistributions: type: array description: An array of containers for the all the condition refinements. items: $ref: '#/components/schemas/ConditionDistribution' dominantCategoryId: type: string description: 'The identifier of the category that most of the items are part of. ' description: This type defines the fields for the various refinements of an item. You can use the information in this container to create histograms, which help shoppers choose exactly what they want. Region: type: object properties: regionName: type: string description: 'A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax. ' regionType: type: string description: 'An enumeration value that indicates the type of region for the tax jurisdiction.

Valid Values: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' description: This type is used to provide region details for a tax jurisdiction. ReviewRating: type: object properties: averageRating: type: string description: The average rating given to a product based on customer reviews. ratingHistograms: type: array description: An array of containers for the product rating histograms that shows the review counts and the product rating. items: $ref: '#/components/schemas/RatingHistogram' reviewCount: type: integer description: The total number of reviews for the item. format: int32 description: The type that defines the fields for the rating of a product review. SearchByImageRequest: type: object properties: image: type: string description: The Base64 string of the image.

To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter. description: The type that defines the fields for the image information. SearchPagedCollection: type: object properties: autoCorrections: description: The auto-corrected inputs. $ref: '#/components/schemas/AutoCorrections' href: type: string description: The URI of the current page of results.

The following example of the search method returns items 1 thru 5 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0
. itemSummaries: type: array description: An array of the items on this page. The items are sorted according to the sorting method specified in the request. items: $ref: '#/components/schemas/ItemSummary' limit: type: integer description: The value of the limit parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method. format: int32 next: type: string description: The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.

The following example of the search method returns items 5 thru 10 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10
offset: type: integer description: This value indicates the offset used for current page of items being returned. Assume the initial request used an offset of 0 and a limit of 3. Then in the first page of results, this value would be 0, and items 1-3 are returned. For the second page, this value is 3 and so on. format: int32 prev: type: string description: The URI for the previous page of results. This is returned if there is a previous page of results from the result set.

The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0
refinement: description: The container for all the search refinements. $ref: '#/components/schemas/Refinement' total: type: integer description: The total number of items that match the input criteria.

Note: total is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that total not be used in pagination use cases. Instead, use next to determine the results on the next page. format: int32 warnings: type: array description: The container with all the warnings for the request. items: $ref: '#/components/schemas/Error' description: The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced pages where each page has 0 or more items. Seller: type: object properties: feedbackPercentage: type: string description: The percentage of the total positive feedback. feedbackScore: type: integer description: The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. format: int32 sellerAccountType: type: string description: Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay: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, EBAY_PL

Valid Values: BUSINESS or INDIVIDUAL username: type: string description: The user name created by the seller for use on eBay. description: The type that defines the fields for basic information about the seller of the item returned by the item_summary resource. SellerCustomPolicy: type: object properties: description: type: string description: The seller-defined description of the policy. label: type: string description: The seller-defined label for an individual custom policy. type: type: string description: The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK. For implementation help, refer to eBay API documentation description: The container for custom policies that apply to a listed item. SellerDetail: type: object properties: feedbackPercentage: type: string description: The percentage of the total positive feedback. feedbackScore: type: integer description: The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. format: int32 sellerAccountType: type: string description: 'This indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following 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, EBAY_PL

Valid Values: BUSINESS or INDIVIDUAL

Code so that your app gracefully handles any future changes to this list. ' sellerLegalInfo: description: The container with the seller's contact info and fields that are required by law. $ref: '#/components/schemas/SellerLegalInfo' userId: type: string description: The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username. username: type: string description: The user name created by the seller for use on eBay. description: The type that defines the fields for basic and detailed information about the seller of the item returned by the item resource. SellerLegalInfo: type: object properties: email: type: string description: The seller's business email address. fax: type: string description: The seller' business fax number. imprint: type: string description: This is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries. legalContactFirstName: type: string description: The seller's first name. legalContactLastName: type: string description: The seller's last name. name: type: string description: The name of the seller's business. phone: type: string description: The seller's business phone number. registrationNumber: type: string description: The seller's registration number. This is information used by some countries. sellerProvidedLegalAddress: description: The container that returns the seller's address to be used to contact them. $ref: '#/components/schemas/LegalAddress' termsOfService: type: string description: This is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies. vatDetails: type: array description: An array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries. items: $ref: '#/components/schemas/VatDetail' economicOperator: description: Provides required information about the manufacturer and/or supplier of the item. $ref: '#/components/schemas/EconomicOperator' weeeNumber: type: string description: The Waste Electrical and Electronic Equipment (WEEE) registration number required for any seller to place electrical and electronic equipment on the market in Germany. This manufacturer number is assigned to the first distributors of electrical and electronic equipment and comprises a country code and an 8-digit sequence of digits (e.g. “WEEE Reg. No. DE 12345678”). description: The type that defines the fields for the contact information for a seller. ShipToLocation: type: object properties: country: type: string description: The two-letter ISO 3166 standard of the country for where the item is to be shipped. For implementation help, refer to eBay API documentation postalCode: type: string description: The zip code (postal code) for where the item is to be shipped. description: The type that defines the fields for the country and postal code of where an item is to be shipped. ShipToLocations: type: object properties: regionExcluded: type: array description: An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to. items: $ref: '#/components/schemas/ShipToRegion' regionIncluded: type: array description: An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the regionExcluded to see where the seller is willing to ship items. Sellers can specify that they ship 'Worldwide', but then add several large geographical regions (e.g. Asia, Oceania, Middle East) to the exclusion list, or sellers can specify that they ship to Europe and Africa, but then add several individual countries to the exclusion list. items: $ref: '#/components/schemas/ShipToRegion' description: The type that defines the fields that include and exclude geographic regions affecting where the item can be shipped. The seller defines these regions when listing the item. ShipToRegion: type: object properties: regionId: type: string description: 'The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region.

If the regionType value is WORLDWIDE, the regionId value will also be WORLDWIDE.

If the regionType value is WORLD_REGION, the regionId value will be one of the following: AFRICA, AMERICAS, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EUROPEAN_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, SOUTH_AMERICA, SOUTHEAST_ASIA or CHANNEL_ISLANDS.

If the regionType value is COUNTRY, the regionId value will be the two-letter code for the country, as defined in the ISO 3166 standard.

If the regionType value is STATE_OR_PROVINCE, the regionId value will either be the two-letter code for US states and DC (as defined on this Social Security Administration page), or the two-letter code for Canadian provinces (as defined by this Canada Post page).

If the regionType value is COUNTRY_REGION, the regionId value may be one of following: _AH (if a seller is not willing to ship to Alaska/Hawaii), _PR (if the seller is not willing to ship to US Protectorates), _AP (if seller is not willing to ship to a US Army or Fleet Post Office), and PO_BOX (if the seller is not willing to ship to a Post Office Box).' regionName: type: string description: 'A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value.

If the regionType value is WORLDWIDE, the regionName value will show Worldwide.

If the regionType value is WORLD_REGION, the regionName value will be a localized text string for one of the following large geographical regions: Africa, Americas, Asia, Australia, Central America and Caribbean, Europe, European Union, Greater China, Middle East, North America, Oceania, South America, Southeast Asia, or Channel Islands.

If the regionType value is COUNTRY, the regionName value will be a localized text string for any country in the world.

If the regionType value is STATE_OR_PROVINCE, the regionName value will be a localized text string for any US state or Canadian province.

If the regionType value is COUNTRY_REGION, the regionName value may be a localized version of one of the following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post Office), or PO BOX.' regionType: type: string description: 'An enumeration value that indicates the level or type of shipping region.

Valid Values:
  • COUNTRY_REGION - Indicates the region is a domestic region or special location within a country.
  • STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
  • COUNTRY - Indicates the region is a single country.
  • WORLD_REGION - Indicates the region is a world region, such as Africa, the Middle East, or Southeast Asia.
  • WORLDWIDE - Indicates the region is the entire world. This value is only applicable for included shiping regions, and not excluded shipping regions.
For more detail on the actual regionName/regionId values that will be returned based on the regionType value, see the regionId and/or regionName field descriptions.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' description: This type is used provide details about included and excluded shipping regions. ShippingOption: type: object properties: additionalShippingCostPerUnit: description: 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). $ref: '#/components/schemas/ConvertedAmount' cutOffDateUsedForEstimate: type: string description: The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. fulfilledThrough: type: string description: If the item is being shipped by the eBay Global Shipping program, this field returns GLOBAL_SHIPPING.

If the item is being shipped using the eBay International Shipping program, this field returns INTERNATIONAL_SHIPPING.

Otherwise, this field is null. For implementation help, refer to eBay API documentation guaranteedDelivery: type: boolean description: Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future. importCharges: description: The Global Shipping Program import charges for this item. $ref: '#/components/schemas/ConvertedAmount' maxEstimatedDeliveryDate: type: string description: 'The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header. ' minEstimatedDeliveryDate: type: string description: 'The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.' quantityUsedForEstimate: type: integer description: The number of items used when calculating the estimation information. format: int32 shippingCarrierCode: type: string description: The name of the shipping provider, such as FedEx, or USPS. shippingCost: description: 'The final shipping cost for all the items after all discounts are applied.

Note: The cost does include 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 cost. For more information on VAT, refer to VAT Obligations in the EU.' $ref: '#/components/schemas/ConvertedAmount' shippingCostType: type: string description: '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. ' shippingServiceCode: type: string description: The type of shipping service. For example, USPS First Class. shipToLocationUsedForEstimate: description: The container that returns the country and postal code of where the item is to be shipped. These values come from the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used. $ref: '#/components/schemas/ShipToLocation' trademarkSymbol: type: string description: Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name. type: type: string description: The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc. description: The type that defines the fields for the details of a shipping provider. ShippingOptionSummary: type: object properties: guaranteedDelivery: type: boolean description: Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future. maxEstimatedDeliveryDate: type: string description: 'The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header.' minEstimatedDeliveryDate: type: string description: The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. shippingCost: description: This is the estimated price to ship the item.

The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to see VAT-inclusive pricing:
  • Pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB)
  • Pass the contextualLocation values for the supported marketplace in the X-EBAY-C-ENDUSERCTX request header
  • Specify the supported marketplace using the deliveryCountry filter URI parameter (such as filter=deliveryCountry:GB)
Note:For more information on VAT, refer to Your VAT Obligations in the UK & EU. $ref: '#/components/schemas/ConvertedAmount' shippingCostType: type: string description: Indicates the type of shipping used to ship the item. Possible values are FIXED (flat-rate shipping) and CALCULATED (shipping cost calculated based on item and buyer location). description: The type that defines the fields for the shipping information. TargetLocation: type: object properties: unitOfMeasure: type: string description: This value shows the unit of measurement used to measure the distance between the location of the item and the buyer's location. This value is typically mi or km. value: type: string description: This value indicates the distance (measured in the measurement unit in the unitOfMeasure field) between the item location and the buyer's location. description: 'The type that defines the fields for the distance between the item location and the buyer''s location. ' TaxJurisdiction: type: object properties: region: description: The region of the tax jurisdiction. $ref: '#/components/schemas/Region' taxJurisdictionId: type: string description: The identifier of the tax jurisdiction. description: The type that defines the fields for the tax jurisdiction details. Taxes: type: object properties: ebayCollectAndRemitTax: type: boolean description: 'This field is only returned if true, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer''s residence. ' includedInPrice: type: boolean description: This indicates if tax was applied for the cost of the item. shippingAndHandlingTaxed: type: boolean description: This indicates if tax is applied for the shipping cost. taxJurisdiction: description: The container that returns the tax jurisdiction. $ref: '#/components/schemas/TaxJurisdiction' taxPercentage: type: string description: The percentage of tax. taxType: type: string description: This field indicates the type of tax that may be collected for the item. For implementation help, refer to eBay API documentation description: The type that defines the tax fields. TimeDuration: type: object properties: unit: type: string description: An enumeration value that indicates the units of the time span (e.g., HOURS). The enumeration value in this field defines the period of time being used to measure the duration.

Refer to TimeDurationUnitEnum for the list of supported values. For implementation help, refer to eBay API documentation value: type: integer description: Retrieves the duration of the time span (no units). The value in this field indicates the number of years, months, days, hours, or minutes in the defined period. format: int32 description: The type that defines the fields for a period of time in the time-measurement units supplied. TypedNameValue: type: object properties: name: type: string description: The text representing the name of the aspect for the name/value pair, such as Color. type: type: string description: 'This indicates if the value being returned is a string or an array of values.

Valid Values:
  • STRING - Indicates the value returned is a string.
  • STRING_ARRAY - Indicates the value returned is an array of strings.
Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation' value: type: string description: The value of the aspect for the name/value pair, such as Red. description: The type that defines the fields for the name/value pairs for item aspects. VatDetail: type: object properties: issuingCountry: type: string description: The two-letter ISO 3166 standard of the country issuing the seller's VAT (value added tax) ID. VAT is a tax added by some European countries. For implementation help, refer to eBay API documentation vatId: type: string description: The seller's VAT (value added tax) ID. VAT is a tax added by some European countries. description: The type the defines the fields for the VAT (value add tax) information. securitySchemes: api_auth: type: oauth2 description: The security definitions for this API. Please check individual operations for applicable scopes. flows: clientCredentials: tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/buy.item.bulk: Retrieve eBay items in bulk. https://api.ebay.com/oauth/api_scope: View public data from eBay