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
| Name | Type | Description |
|---|---|---|
query? | StoreGetProductsParams | is optional. Can contain a limit and offset for the returned list |
customHeaders | Record<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
| Name | Type | Description |
|---|---|---|
id | string | is required |
customHeaders | Record<string, any> |
Returns
ResponsePromise<StoreProductsRes>
Defined in
medusa-js/src/resources/products.ts:22
search
▸ search(searchOptions, customHeaders?): ResponsePromise<StorePostSearchRes>
Description
Searches for products
Parameters
| Name | Type | Description |
|---|---|---|
searchOptions | StorePostSearchReq | is required |
customHeaders | Record<string, any> |
Returns
ResponsePromise<StorePostSearchRes>