daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2.8 KiB
2.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminVariantsResource
Hierarchy
-
default↳
AdminVariantsResource
Methods
getInventory
▸ getInventory(variantId, customHeaders?): ResponsePromise<AdminGetVariantsVariantInventoryRes>
Parameters
| Name | Type | Description |
|---|---|---|
variantId |
string |
id of the variant to fetch inventory for |
customHeaders |
Record<string, any> |
custom headers |
Returns
ResponsePromise<AdminGetVariantsVariantInventoryRes>
Defined in
packages/medusa-js/src/resources/admin/variants.ts:60
list
▸ list(query?, customHeaders?): ResponsePromise<AdminVariantsListRes>
List product variants
Parameters
| Name | Type | Description |
|---|---|---|
query? |
AdminGetVariantsParams |
Query to filter variants by |
customHeaders |
Record<string, any> |
custom headers |
Returns
ResponsePromise<AdminVariantsListRes>
A list of variants satisfying the criteria of the query
Defined in
packages/medusa-js/src/resources/admin/variants.ts:19
retrieve
▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminVariantsRes>
Get a product variant
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
Query to filter variants by |
query? |
AdminGetVariantParams |
- |
customHeaders |
Record<string, any> |
custom headers |
Returns
ResponsePromise<AdminVariantsRes>
A list of variants satisfying the criteria of the query