asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: added reference for JS Client (#1629)

Browse Source 
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
This commit is contained in:
Shahed Nasser
2022-07-08 18:21:46 +03:00
committed by GitHub
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/content/references/js-client/classes/ProductVariantsResource.md Normal file
View File

@@ -0,0 +1,53 @@
# Class: ProductVariantsResource
## Hierarchy
- `default`
↳ **`ProductVariantsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
**`description`** Retrieves a list of of Product Variants
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
#### Defined in
[packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L28)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
**`description`** Retrieves a single product variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
#### Defined in
[packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L17)