Class: ProductsResource
Hierarchy
defaultCopy to Clipboard↳
ProductsResourceCopy to Clipboard
Properties
variants
• variants: ProductVariantsResourceCopy to Clipboard
Defined in
medusa-js/src/resources/products.ts:14
Methods
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreProductsListResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves a list of products
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | StoreGetProductsParamsCopy to Clipboard | is optional. Can contain a limit and offset for the returned list |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreProductsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/products.ts:50
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreProductsResCopy to Clipboard>
DescriptionCopy to Clipboard
Retrieves a single Product
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreProductsResCopy to Clipboard>
Defined in
medusa-js/src/resources/products.ts:22
search
▸ search(searchOptionsCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StorePostSearchResCopy to Clipboard>
DescriptionCopy to Clipboard
Searches for products
Parameters
| Name | Type | Description |
|---|---|---|
searchOptionsCopy to Clipboard | StorePostSearchReqCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StorePostSearchResCopy to Clipboard>