catalog APIv1_beta.3.0

getProduct

GET
/product/{epid}
This call 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 call to identify candidate products on which to base the listing, then use the getProduct call to present the full details of those candidate products to the seller to makea a final selection.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/catalog/v1_beta/product/{epid}

URI parameters

ParameterTypeDescription
epidstringThe ePID of the product being requested. This value can be discovered by issuing the search call and examining the value of the productSummaries.epid field for the desired returned product summary.

Occurrence: Required

HTTP request headers

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

This call also uses the X-EBAY-C-MARKETPLACE-ID header to identify the user's business context. This header is currently limited to EBAY-US, EBAY-AU, EBAY-CA, and EBAY-GB values. If not included with your request, the marketplace value defaults to EBAY-US. Note that it does not indicate a language preference or end-user location.

Examples:
X-EBAY-C-MARKETPLACE-ID: EBAY-US
X-EBAY-C-MARKETPLACE-ID: EBAY-AU

OAuth scope

This request requires an access token created with the authorization code grant flow, using one scope from the following list:

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.

Output

HTTP response headers

{ /* Product */
"additionalImages" : [
{ /* Image */ }
],
"brand" : "string",
"ean" : [],
"epid" : "string",
"gtin" : [],
"image" :
{ /* Image */ },
"isbn" : [],
"mpn" : [],
"title" : "string",
"upc" : [],
}
Output container/fieldTypeDescription
additionalImagesarray of ImageContains information about additional images associated with this product. For the primary image, see the image container.

Occurrence: Conditional

additionalImages.heightintegerThe height of the image in pixels.

Occurrence: Conditional

additionalImages.imageUrlstringThe eBay Picture Services (EPS) URL of the image.

Occurrence: Always

additionalImages.widthintegerThe width of the image in pixels.

Occurrence: Conditional

aspectsarray of AspectContains an array of the category aspects and their values that are associated with this product.

Occurrence: Conditional

aspects.localizedNamestringThe localized name of this category aspect.

Occurrence: Conditional

aspects.localizedValuesarray of stringA list of the localized values of this category aspect.

Occurrence: Conditional

brandstringThe manufacturer's brand name for this product.

Occurrence: Conditional

descriptionstringThe rich description of this product, which might contain HTML.

Occurrence: Always

eanarray of stringA list of all European Article Numbers (EANs) that identify this product.

Occurrence: Conditional

epidstringThe eBay product ID of this product.

Occurrence: Always

gtinarray of stringA list of all GTINs that identify this product. Currently this can include EAN, ISBN, and UPC identifier types.

Occurrence: Conditional

imageImageContains information about the primary image of this product. For more images of this product, see the additionalImages container.

Occurrence: Always

image.heightintegerThe height of the image in pixels.

Occurrence: Conditional

image.imageUrlstringThe eBay Picture Services (EPS) URL of the image.

Occurrence: Always

image.widthintegerThe width of the image in pixels.

Occurrence: Conditional

isbnarray of stringA list of all International Standard Book Numbers (ISBNs) that identify this product.

Occurrence: Conditional

mpnarray of stringA list of all MPN values that the manufacturer uses to identify this product.

Occurrence: Conditional

otherApplicableCategoryIdsarray of stringA list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which this product might belong.

Occurrence: Conditional

primaryCategoryIdstringThe 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

productWebUrlstringThe URL for this product's eBay product page.

Occurrence: Conditional

titlestringThe title of this product on eBay.

Occurrence: Always

upcarray of stringA list of Universal Product Codes (UPCs) that identify this product.

Occurrence: Conditional

versionstringThe 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.

StatusMeaning
200OK
400Bad Request
403Forbidden
404Not Found
500Internal Server Error

Error codes

CodeDomainCategoryMeaning
75000API_CATALOGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
75007API_CATALOGREQUESTCurrently, the {marketplaceId} marketplace is not supported. The supported Marketplaces are: {allowedMarketplaces}.
75010API_CATALOGREQUESTThe specified EPID value {epid} was not found.
75011API_CATALOGREQUESTThe specified EPID value {epid} no longer exists. Its new value is {newepid}.
75015API_CATALOGREQUESTInsufficient permissions to fulfill the request.
75016API_CATALOGREQUESTThe specified EPID value {epid} is no longer available.

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.
GET
https://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.