ProductVariantsResource

This class is used to send requests to Store Product Variant API Routes. All its method are available in the JS Client under the medusa.product.variants property.

Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product.

Methods

list

Retrieves a list of product variants. The product variants can be filtered by fields such as id or title passed in the query parameter. The product variants can also be paginated.

For accurate and correct pricing of the product variants based on the customer's context, it's highly recommended to pass fields such as region_id, currency_code, and cart_id when available.

Passing sales_channel_id ensures retrieving only variants of products available in the specified sales channel. You can alternatively use a publishable API key in the request header instead of passing a sales_channel_id.

Example

To list product variants:

import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.product.variants.list().then(({ variants }) => {
  console.log(variants.length)
})

To specify relations that should be retrieved within the product variants:

import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.product.variants
  .list({
    expand: "product",
  })
  .then(({ variants }) => {
    console.log(variants.length)
  })

By default, only the first 100 records are retrieved. You can control pagination by specifying the limit and offset properties:

import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.product.variants
  .list({
    expand: "product",
    limit,
    offset,
  })
  .then(({ variants }) => {
    console.log(variants.length)
  })

Parameters

queryStoreGetVariantsParams

Filters and pagination configurations applied on the retrieved product variants.

customHeadersRecord<string, any>Required

Custom headers to attach to the request.

Default: {}

Returns

ResponsePromiseResponsePromise<StoreVariantsListRes>Required

Resolves to the list of product variants.

---

retrieve

Retrieve a Product Variant's details. For accurate and correct pricing of the product variant based on the customer's context, it's highly recommended to pass fields such as region_id, currency_code, and cart_id when available.

Passing sales_channel_id ensures retrieving only variants of products available in the current sales channel. You can alternatively use a publishable API key in the request header instead of passing a sales_channel_id.

Example

import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
  console.log(variant.id)
})

Parameters

idstringRequired

The ID of the product variant.

customHeadersRecord<string, any>Required

Custom headers to attach to the request.

Default: {}

Returns

ResponsePromiseResponsePromise<StoreVariantsRes>Required

Resolves to the product variant's details.