getProduct: eBay Catalog API | eBay Developers Program

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

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

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

Parameter	Type	Description
epid	string	The eBay product identifier (ePID) of the product being requested. This value can be discovered by issuing the search method 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.

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

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

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

Copy complete valid JSON to clipboard

{ /* Product */

"additionalImages" : [

{ /* Image */

"height" : "integer",

"imageUrl" : "string",

"width" : "integer"

}

"aspects" : [

{ /* Aspect */

"localizedName" : "string",

"localizedValues" : [

"string"

]

}

"brand" : "string",

"description" : "string",

"ean" : [

"string"

"epid" : "string",

"gtin" : [

"string"

"image" :

{ /* Image */

"height" : "integer",

"imageUrl" : "string",

"width" : "integer"

"isbn" : [

"string"

"mpn" : [

"string"

"otherApplicableCategoryIds" : [

"string"

"primaryCategoryId" : "string",

"productWebUrl" : "string",

"title" : "string",

"upc" : [

"string"

"version" : "string"

}

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.

{
    "aspects": [
        {
            "localizedName": "Matching MPN",
            "localizedValues": [
                "MN8G2LL/A",
                "MNAC2LL/A",
                "MNAY2LL/A"
            ]
        },
        {
            "localizedName": "Model Number",
            "localizedValues": [
                "A1660 (CDMA + GSM)"
            ]
        },
        {
            "localizedName": "Network",
            "localizedValues": [
                "Unlocked"
            ]
        },
        {
            "localizedName": "Family Line",
            "localizedValues": [
                "Apple iPhone"
            ]
        },
        {
            "localizedName": "Model",
            "localizedValues": [
                "7"
            ]
        },
        {
            "localizedName": "UPC",
            "localizedValues": [
                "190198072078"
            ]
        },
        {
            "localizedName": "Type",
            "localizedValues": [
                "Smartphone"
            ]
        },
        {
            "localizedName": "Storage Capacity",
            "localizedValues": [
                "32GB"
            ]
        },
        {
            "localizedName": "Color",
            "localizedValues": [
                "Black"
            ]
        },
        {
            "localizedName": "Network Generation",
            "localizedValues": [
                "2G",
                "3G",
                "4G"
            ]
        },
        {
            "localizedName": "Network Technology",
            "localizedValues": [
                "CDMA / EVDO Rev. A",
                "GSM / EDGE / UMTS / HSPA+ / DC-HSDPA / FDD-LTE / TD-LTE",
                "TD-SCDMA"
            ]
        },
        {
            "localizedName": "Style",
            "localizedValues": [
                "Bar"
            ]
        },
        {
            "localizedName": "Camera Resolution",
            "localizedValues": [
                "12.0MP"
            ]
        },
        {
            "localizedName": "Connectivity",
            "localizedValues": [
                "Bluetooth",
                "NFC",
                "USB",
                "WiFi"
            ]
        },
        {
            "localizedName": "Supported Flash Memory Cards",
            "localizedValues": [
                "Built-In Memory"
            ]
        },
        {
            "localizedName": "Battery Type",
            "localizedValues": [
                "Lithium Ion"
            ]
        },
        {
            "localizedName": "Battery Capacity",
            "localizedValues": [
                "1960 mAh"
            ]
        },
        {
            "localizedName": "Battery Talk Time",
            "localizedValues": [
                "Up to 840 min"
            ]
        },
        {
            "localizedName": "Battery Standby Time",
            "localizedValues": [
                "Up to 240 hr"
            ]
        },
        {
            "localizedName": "Display Technology",
            "localizedValues": [
                "Retina HD with 3D Touch"
            ]
        },
        {
            "localizedName": "Screen Size",
            "localizedValues": [
                "4.7\""
            ]
        },
        {
            "localizedName": "Display Resolution",
            "localizedValues": [
                "1334x750"
            ]
        },
        {
            "localizedName": "Touch Screen",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "Bluetooth",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "Digital Camera",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "GPS",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "QWERTY Physical Keyboard",
            "localizedValues": [
                "No"
            ]
        },
        {
            "localizedName": "Email Access",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "Internet Browser",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "Speakerphone",
            "localizedValues": [
                "Yes"
            ]
        },
        {
            "localizedName": "Height",
            "localizedValues": [
                "5.44 in."
            ]
        },
        {
            "localizedName": "Depth",
            "localizedValues": [
                "0.28 in."
            ]
        },
        {
            "localizedName": "Width",
            "localizedValues": [
                "2.64 in."
            ]
        },
        {
            "localizedName": "Weight",
            "localizedValues": [
                "4.87 oz"
            ]
        },
        {
            "localizedName": "Release Date",
            "localizedValues": [
                "2016"
            ]
        }
    ],
    "title": "Apple iPhone 7 - 32GB - Black (Unlocked) A1660 (CDMA + GSM)",
    "description": "This iPhone 7 is a factory unlocked Apple smartphone with an 4.7 inches multitouch Display and a water restistant case which protects against spills and splashes. It is powered by quad-core processor, a six-core grasphic processor, has an internal 32 GB memory card with 2 GB RAM and the upgradable operating system iOS 10.0.1. A fingerprint sensor, Siri voice control system, audio, video and document editors are only some of the features. The build-in lithium-ion battery enables up to 14 hours of talk time/mobile data usage or up to 40 hours music play. The 12MP HDR-camera comes with phase detection autofocus, touch focus and smile detection and permits simultaneous 8MP image and 4k video recording. The phone measures 138.3 x 67.1 x 7.1 mm, weighs 138g and requires an Nano-SIM.",
    "image": {
        "imageUrl": "https://i.ebayimg.com/00/s/NjgwWDU5Ng==/z/6T0AAOSwWxNYpDWn/$_6.JPG?set_id=89040003C1"
    },
    "gtin": [
        "0190198072078"
    ],
    "mpn": [
        "MN8G2LL/A"
    ],
    "ean": [
        "0190198072078"
    ],
    "upc": [
        "0190198072078"
    ],
    "brand": "Apple",
    "epid": "232669172",
    "productWebUrl": "https://www.ebay.com/p/Apple+iPhone+7+%2D+32GB+%2D+Black+%28Unlocked%29+A1660+%28CDMA+%2B+GSM%29/232669172",
    "primaryCategoryId": "9355",
    "otherApplicableCategoryIds": [
        "9355"
    ]
}