GET/product/{epid}
This method retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in the request. These details include the product's title and description, aspects and their values, associated images, applicable category IDs, and any recognized identifiers that apply to the product.
For a new listing, you can use the search method to identify candidate products on which to base the listing, then use the getProduct method to present the full details of those candidate products to the seller to make a a final selection.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
Header | Type | Description |
---|---|---|
X-EBAY-C-MARKETPLACE-ID | string | This method also uses the X-EBAY-C-MARKETPLACE-ID header to identify the seller's eBay marketplace. It is required for all supported marketplaces, except EBAY_US, which is the default. Occurrence: Conditional |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
See OAuth access tokens for more information.
Note: Only the sell.inventory
scope is required for selling applications, and only the commerce.catalog.readonly
scope is required for buying applications.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
additionalImages | array of Image | Contains information about additional images associated with this product. For the primary image, see the image container. Occurrence: Conditional |
additionalImages.height | integer | The height of the image in pixels. Occurrence: Conditional |
additionalImages.imageUrl | string | The eBay Picture Services (EPS) URL of the image. Occurrence: Always |
additionalImages.width | integer | The width of the image in pixels. Occurrence: Conditional |
aspects | array of Aspect | Contains an array of the category aspects and their values that are associated with this product. Occurrence: Conditional |
aspects.localizedName | string | The localized name of this category aspect. Occurrence: Conditional |
aspects.localizedValues | array of string | A list of the localized values of this category aspect. Occurrence: Conditional |
brand | string | The manufacturer's brand name for this product. Occurrence: Conditional |
description | string | The rich description of this product, which might contain HTML. Occurrence: Always |
ean | array of string | A list of all European Article Numbers (EANs) that identify this product. Occurrence: Conditional |
epid | string | The eBay product ID of this product. Occurrence: Always |
gtin | array of string | A list of all GTINs that identify this product. Currently this can include EAN, ISBN, and UPC identifier types. Occurrence: Conditional |
image | Image | Contains information about the primary image of this product. For more images of this product, see the additionalImages container. Occurrence: Always |
image.height | integer | The height of the image in pixels. Occurrence: Conditional |
image.imageUrl | string | The eBay Picture Services (EPS) URL of the image. Occurrence: Always |
image.width | integer | The width of the image in pixels. Occurrence: Conditional |
isbn | array of string | A list of all International Standard Book Numbers (ISBNs) that identify this product. Occurrence: Conditional |
mpn | array of string | A list of all MPN values that the manufacturer uses to identify this product. Occurrence: Conditional |
otherApplicableCategoryIds | array of string | A list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which this product might belong. Occurrence: Conditional |
primaryCategoryId | string | The identifier of the leaf category that eBay recommends using to list this product, based on previous listings of similar products. Products in the eBay catalog are not automatically associated with any particular category, but using an inappropriate category can make it difficult for prospective buyers to find the product. For other possible categories that might be used, see otherApplicableCategoryIds. Occurrence: Always |
productWebUrl | string | The URL for this product's eBay product page. Occurrence: Conditional |
title | string | The title of this product on eBay. Occurrence: Always |
upc | array of string | A list of Universal Product Codes (UPCs) that identify this product. Occurrence: Conditional |
version | string | The current version number of this product record in the catalog. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
200 | OK |
400 | Bad Request |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
75000 | API_CATALOG | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
75007 | API_CATALOG | REQUEST | Currently, the {marketplaceId} marketplace is not supported. The supported Marketplaces are: {allowedMarketplaces}. |
75010 | API_CATALOG | REQUEST | The specified EPID value {epid} was not found. |
75011 | API_CATALOG | REQUEST | The specified EPID value {epid} no longer exists. Its new value is {newepid}. |
75015 | API_CATALOG | REQUEST | Insufficient permissions to fulfill the request. |
75016 | API_CATALOG | REQUEST | The specified EPID value {epid} is no longer available. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get Product Details
This sample returns the details of the specified product by passing in the ePID of the product. The ePID was returned by the search call in the productSummaries.epid field. You can also use the URI that was returned in the search call's productSummaries.productHref field.
Input
The input is the epid URI parameter, which specifies the ePID of the product. There is no payload with this request.
GEThttps://api.ebay.com/commerce/catalog/v1_beta/product/232669172
Output
The details are returned for the corresponding product titled "Apple iPhone 7 - 32GB - Black (Unlocked) A1660 (CDMA + GSM)." It also has aspects that are returned in the aspects container.