Skip to main content

Class: ProductsResource

Hierarchy

  • default

    ProductsResource

Properties

variants

variants: ProductVariantsResource

Defined in

medusa-js/src/resources/products.ts:14

Methods

list

list(query?, customHeaders?): ResponsePromise<StoreProductsListRes>

Description

Retrieves a list of products

Parameters

NameTypeDescription
query?StoreGetProductsParamsis optional. Can contain a limit and offset for the returned list
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreProductsListRes>

Defined in

medusa-js/src/resources/products.ts:50


retrieve

retrieve(id, customHeaders?): ResponsePromise<StoreProductsRes>

Description

Retrieves a single Product

Parameters

NameTypeDescription
idstringis required
customHeadersRecord<string, any>

Returns

ResponsePromise<StoreProductsRes>

Defined in

medusa-js/src/resources/products.ts:22


search(searchOptions, customHeaders?): ResponsePromise<StorePostSearchRes>

Description

Searches for products

Parameters

NameTypeDescription
searchOptionsStorePostSearchReqis required
customHeadersRecord<string, any>

Returns

ResponsePromise<StorePostSearchRes>

Defined in

medusa-js/src/resources/products.ts:36

Was this page helpful?