Skip to main content

productcatalog.proto

path protobuffet/example/productcatalog/v1/productcatalog.proto

package protobuffet.example.productcatalog.v1


Messages

Empty

Represents no data required.

NameTypeDescription

GetProductRequest

Request to get a single product.

NameTypeDescription
idstringIdentifier to use for product lookup.

ListProductsResponse

Response containing a list of retrieved products.

NameTypeDescription
productsrepeated ProductList of products.

Product

Represents a single product within our catalog. Each product should be visible by default, unavailable products are not represented by this object.

NameTypeDescription
idstringIdentifier for this product.
namestringName of this product. Often provided by the retailer or some third-party.
descriptionstringDescription of this product. Often provided by the retailer or some third-party.
picturestringPicture of this product. Often provided by some third-party.
price_usdprotobuffet.example.common.types.v1.MoneyPrice of this product at this given time. Calculations can vary with time, so caching should respect this.
categoriesrepeated stringCategories such as "vintage" or "gardening" that can be used to look up other related products.

SearchProductsRequest

Request to search for products given a query.

NameTypeDescription
querystringQuery of terms to search for within the catalog. See implementation docs for formatting.

SearchProductsResponse

Response containing a list of product search results.

NameTypeDescription
resultsrepeated ProductList of products.

Services

ProductCatalogService

Product catalog management service. APIs oriented around product lookup for a given context.

ListProducts

MethodListProducts
RequestEmpty
ResponseListProductsResponse
DescriptionList all products in the catalog.

GetProduct

MethodGetProduct
RequestGetProductRequest
ResponseProduct
DescriptionGet a specific product from our catalog.

SearchProducts

MethodSearchProducts
RequestSearchProductsRequest
ResponseSearchProductsResponse
DescriptionSearch for products within the catalog matching a given query.