AdminVariantsResource

admin/variants.AdminVariantsResource

Methods

getInventory

getInventory(variantId, customHeaders?): ResponsePromise<AdminGetVariantsVariantInventoryRes>

Parameters

variantIdstringRequired

id of the variant to fetch inventory for

customHeadersRecord<string, any>Required

custom headers

Default: `{}`

Returns

ResponsePromise<AdminGetVariantsVariantInventoryRes>

ResponsePromiseResponsePromise<AdminGetVariantsVariantInventoryRes>Required

---

list

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

List product variants

Parameters

queryAdminGetVariantsParams

Query to filter variants by

customHeadersRecord<string, any>Required

custom headers

Default: `{}`

Returns

ResponsePromise<AdminVariantsListRes>

ResponsePromiseResponsePromise<AdminVariantsListRes>Required

A list of variants satisfying the criteria of the query

---

retrieve

retrieve(id, query?, customHeaders?): ResponsePromise<AdminVariantsRes>

Get a product variant

Parameters

idstringRequired

Query to filter variants by

queryAdminGetVariantParams

customHeadersRecord<string, any>Required

custom headers

Default: `{}`

Returns

ResponsePromise<AdminVariantsRes>

ResponsePromiseResponsePromise<AdminVariantsRes>Required

A list of variants satisfying the criteria of the query