Retrieve Product Variant

In this guide, you'll learn how to retrieve product variants' prices in the storefront, including sale prices.

Pricing Query Parameters

When you retrieve products either with the List Products or Retrieve Products API routes, you must include in the beginning of the fields query parameter the value *variants.calculated_price to retrieve the product variants' prices.

You also must pass at least one of the following query parameters to retrieve an accurate product variant price:

For example:

1sdk.store.product.retrieve("us", id, {
2  fields: `*variants.calculated_price`,
3  region_id: region.id,
4})
5.then(({ product: dataProduct }) => {
6  // TODO use product
7  console.log(product)
8})

In this example, you pass the selected region's ID as a query parameter with the fields query parameter set to *variants.calculated_price.

Prices for Authenticated Customer

If you pass the customer's authentication token / session in the request, the customer and their group, if available, are automatically used to retrieve prices specific to the customer.

For example, if there's a promotion that applies to the authenticated customer's group, the promotion's prices are used instead of the default prices.

Product Variant's Price Properties

If you pass the parameters mentioned above, each variant has a calculated_price object with the following properties:

Full Code Examples

• Example: Show Product Variant's Price.
• Example: Show Product Variant's Sale Price.
• Example: Show Product Variant's Price with Taxes.