Catalog API — client.commerce.catalog¶
Version v1_beta.5.3 · base path /commerce/catalog/v1_beta · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_product ¶
get_product(epid: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> commerce_catalog_models.Product
get_product(epid: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_product(epid: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> commerce_catalog_models.Product | httpx.Response
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.
search ¶
search(*, x_ebay_c_marketplace_id: str | None = None, aspect_filter: str | None = None, category_ids: str | None = None, fieldgroups: str | None = None, gtin: str | None = None, limit: int | str | None = None, mpn: str | None = None, offset: int | str | None = None, q: str | None = None, raw_response: Literal[False] = False) -> commerce_catalog_models.ProductSearchResponse
search(*, x_ebay_c_marketplace_id: str | None = None, aspect_filter: str | None = None, category_ids: str | None = None, fieldgroups: str | None = None, gtin: str | None = None, limit: int | str | None = None, mpn: str | None = None, offset: int | str | None = None, q: str | None = None, raw_response: Literal[True]) -> httpx.Response
search(*, x_ebay_c_marketplace_id: str | None = None, aspect_filter: str | None = None, category_ids: str | None = None, fieldgroups: str | None = None, gtin: str | None = None, limit: int | str | None = None, mpn: str | None = None, offset: int | str | None = None, q: str | None = None, raw_response: bool = False) -> commerce_catalog_models.ProductSearchResponse | httpx.Response
This method searches for and retrieves summaries of one or more products in the eBay catalog that match the search criteria provided by a seller. The seller can use the summaries to select the product in the eBay catalog that corresponds to the item that the seller wants to offer for sale.
Models¶
Aspect ¶
Bases: EbayModel
localized_name
class-attribute
instance-attribute
¶
localized_name = Field(None, alias='localizedName', description='The localized name of this category aspect.')
localized_values
class-attribute
instance-attribute
¶
localized_values = Field(None, alias='localizedValues', description='A list of the localized values of this category aspect.')
AspectValueDistribution ¶
Bases: EbayModel
localized_aspect_value
class-attribute
instance-attribute
¶
localized_aspect_value = Field(None, alias='localizedAspectValue', description='The localized value of the category aspect identified by refinement.aspectDistributions.localizedAspectName .')
match_count
class-attribute
instance-attribute
¶
match_count = Field(None, alias='matchCount', description='The number of times the value of localizedAspectValue has been used for eBay product listings. By comparing this quantity to the matchCount for other values of the same aspect, you can present a histogram of the values to sellers, who can use that information to select which aspect value is most appropriate for their product.')
refinement_href
class-attribute
instance-attribute
¶
refinement_href = Field(None, alias='refinementHref', description='A HATEOAS reference that further refines the search with this particular localizedAspectValue .')
ErrorParameter ¶
Image ¶
Bases: EbayModel
height
class-attribute
instance-attribute
¶
height = Field(None, description='The height of the image in pixels.')
image_url
class-attribute
instance-attribute
¶
image_url = Field(None, alias='imageUrl', description='The eBay Picture Services (EPS) URL of the image.')
width
class-attribute
instance-attribute
¶
width = Field(None, description='The width of the image in pixels.')
Product ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='Contains information about additional images associated with this product. For the primary image, see the image container.')
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='Contains an array of the category aspects and their values that are associated with this product.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description="The manufacturer's brand name for this product.")
compatibility_count
class-attribute
instance-attribute
¶
compatibility_count = Field(None, alias='compatibilityCount', description='The number of distinct motor vehicles that are compatible with the product. This field is only applicable for and will only be returned for Parts & Accessory products on the eBay US Motors marketplace.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='The rich description of this product, which might contain HTML.')
ean
class-attribute
instance-attribute
¶
ean = Field(None, description='A list of all European Article Numbers (EANs) that identify this product.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='The eBay product ID of this product.')
gtin
class-attribute
instance-attribute
¶
gtin = Field(None, description='A list of all GTINs that identify this product. Currently this can include EAN, ISBN, and UPC identifier types.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='Contains information about the primary image of this product. For more images of this product, see the additionalImages container.')
isbn
class-attribute
instance-attribute
¶
isbn = Field(None, description='A list of all International Standard Book Numbers (ISBNs) that identify this product.')
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description='A list of all MPN values that the manufacturer uses to identify this product.')
other_applicable_category_ids
class-attribute
instance-attribute
¶
other_applicable_category_ids = Field(None, alias='otherApplicableCategoryIds', description='A list of category IDs (other than the value of primaryCategoryId ) for all the leaf categories to which this product might belong.')
primary_category_id
class-attribute
instance-attribute
¶
primary_category_id = Field(None, alias='primaryCategoryId', description='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.')
product_web_url
class-attribute
instance-attribute
¶
product_web_url = Field(None, alias='productWebUrl', description="The URL for this product's eBay product page.")
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of this product on eBay.')
upc
class-attribute
instance-attribute
¶
upc = Field(None, description='A list of Universal Product Codes (UPCs) that identify this product.')
version
class-attribute
instance-attribute
¶
version = Field(None, description='The current version number of this product record in the catalog.')
ProductSummary ¶
Bases: EbayModel
additional_images
class-attribute
instance-attribute
¶
additional_images = Field(None, alias='additionalImages', description='Contains information about additional images associated with this product. For the primary image, see the image container.')
aspects
class-attribute
instance-attribute
¶
aspects = Field(None, description='Contains an array of the category aspects and their values that are associated with this product.')
brand
class-attribute
instance-attribute
¶
brand = Field(None, description="The manufacturer's brand name for this product.")
ean
class-attribute
instance-attribute
¶
ean = Field(None, description='A list of all European Article Numbers (EANs) that identify this product.')
epid
class-attribute
instance-attribute
¶
epid = Field(None, description='The eBay product ID of this product.')
gtin
class-attribute
instance-attribute
¶
gtin = Field(None, description='A list of all GTINs that identify this product. This includes all of the values returned in the ean , isbn , and upc fields.')
image
class-attribute
instance-attribute
¶
image = Field(None, description='Contains information about the primary image of this product. For more images of this product, see the additionalImages container.')
isbn
class-attribute
instance-attribute
¶
isbn = Field(None, description='A list of all International Standard Book Numbers (ISBNs) that identify this product.')
mpn
class-attribute
instance-attribute
¶
mpn = Field(None, description='A list of all Manufacturer Product Number (MPN) values that the manufacturer uses to identify this product.')
product_href
class-attribute
instance-attribute
¶
product_href = Field(None, alias='productHref', description="The URI of the getProduct call request that retrieves this product's details.")
product_web_url
class-attribute
instance-attribute
¶
product_web_url = Field(None, alias='productWebUrl', description="The URL for this product's eBay product page.")
title
class-attribute
instance-attribute
¶
title = Field(None, description='The title of this product on eBay.')
upc
class-attribute
instance-attribute
¶
upc = Field(None, description='A list of Universal Product Codes (UPCs) that identify this product.')
RangeValue ¶
Bases: EbayModel
end
class-attribute
instance-attribute
¶
end = Field(None, description='This field is reserved for internal use.')
exclusive_end
class-attribute
instance-attribute
¶
exclusive_end = Field(None, alias='exclusiveEnd', description='This field is reserved for internal use.')
exclusive_start
class-attribute
instance-attribute
¶
exclusive_start = Field(None, alias='exclusiveStart', description='This field is reserved for internal use.')
start
class-attribute
instance-attribute
¶
start = Field(None, description='This field is reserved for internal use.')
AspectDistribution ¶
Bases: EbayModel
aspect_value_distributions
class-attribute
instance-attribute
¶
aspect_value_distributions = Field(None, alias='aspectValueDistributions', description='Contains information about one or more values of the category aspect identified by localizedAspectName .')
localized_aspect_name
class-attribute
instance-attribute
¶
localized_aspect_name = Field(None, alias='localizedAspectName', description='The localized name of an aspect that is associated with the category identified by dominantCategoryId .')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
FilterField ¶
Bases: EbayModel
field
class-attribute
instance-attribute
¶
field = Field(None, description='This field is reserved for internal use.')
negated
class-attribute
instance-attribute
¶
negated = Field(None, description='This field is reserved for internal use.')
range
class-attribute
instance-attribute
¶
range = Field(None, description='This container is reserved for internal use.')
set
class-attribute
instance-attribute
¶
set = Field(None, description='This field is reserved for internal use.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='This field is reserved for internal use.')
Refinement ¶
Bases: EbayModel
aspect_distributions
class-attribute
instance-attribute
¶
aspect_distributions = Field(None, alias='aspectDistributions', description='Contains information about one or more aspects that are associated with the category identified by dominantCategoryId .')
dominant_category_id
class-attribute
instance-attribute
¶
dominant_category_id = Field(None, alias='dominantCategoryId', description='The ID of the category that eBay determines is most likely to cover the products matching the search criteria.')
AspectFilter ¶
Bases: EbayModel
category_id
class-attribute
instance-attribute
¶
category_id = Field(None, alias='categoryId', description='The category that the category aspects belong to. This value is a required part of the aspect_filter query parameter. This value can be found in the refinement.dominantCategoryId field when the fieldgroups query parameter is included in the search request with a value of ASPECT_REFINEMENTS or FULL .')
filters
class-attribute
instance-attribute
¶
filters = Field(None, description="An array of aspects of the category identified by categoryId , with one or more aspect values in the form name :{ value1 | value2 } . e.g. Brand:{adidas|Nike} . Possible values can be found in the category's refinement.aspectDistributions container.")
ProductSearchResponse ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='This field is reserved for internal or future use.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of product summaries returned in the response. This is the result set , a subset of the full collection of products that match the search or filter criteria of this call. If the limit query parameter was included in the request, this field will have the same value. Default: 50')
next
class-attribute
instance-attribute
¶
next = Field(None, description='This field is reserved for internal or future use.')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='This field is reserved for internal or future use.')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='This field is reserved for internal or future use.')
product_summaries
class-attribute
instance-attribute
¶
product_summaries = Field(None, alias='productSummaries', description='Returned if the fieldGroups query parameter was omitted from the request, or if it was included with a value of MATCHING_PRODUCTS or FULL . This container provides an array of product summaries in the current result set for products that match the combination of the q , category_ids , and aspect_filter parameters that were provided in the request.')
refinement
class-attribute
instance-attribute
¶
refinement = Field(None, description="Returned only if the fieldGroups query parameter was included in the request with a value of ASPECT_REFINEMENTS or FULL . An aspect is a property of a category, used by sellers to provide details about the items they're listing. For example, the Cell Phones & Smartphones category (#9355) includes a Storage Capacity aspect.")
total
class-attribute
instance-attribute
¶
total = Field(None, description='This field is reserved for internal or future use.')