logo Windmill Hub
Login
Back to Shopify integration
0

Update Product Variant

by
Published Nov 8, 2023

Update a variant's price, SKU, barcode, weight, inventory policy or option values.

Script shopify Verified
Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 2 hours ago
All edits
Permalink
1 
//native
2
3 
/**
4 
 * Update Product Variant
5 
 * Update a variant's price, compare-at price, SKU, barcode, weight or option values. Only the fields you fill in are changed. option_values maps option names to new values (e.g. {"Size": "XL"}).
6 
 */
7 
export async function main(
8 
  auth: RT.Shopify,
9 
  product_id: string,
10 
  variant_id: string,
11 
  price: string | undefined,
12 
  compare_at_price: string | undefined,
13 
  sku: string | undefined,
14 
  barcode: string | undefined,
15 
  weight: number | undefined,
16 
  weight_unit: "KILOGRAMS" | "GRAMS" | "POUNDS" | "OUNCES" | undefined,
17 
  inventory_policy: "DENY" | "CONTINUE" | undefined,
18 
  option_values: { [key: string]: string } | undefined
19 
) {
20 
  const productId = product_id.startsWith("gid://")
21 
    ? product_id
22 
    : `gid://shopify/Product/${product_id}`
23 
  const id = variant_id.startsWith("gid://")
24 
    ? variant_id
25 
    : `gid://shopify/ProductVariant/${variant_id}`
26 
  const inventoryItem = {
27 
    sku: sku || undefined,
28 
    measurement:
29 
      weight != null
30 
        ? { weight: { value: weight, unit: weight_unit || "KILOGRAMS" } }
31 
        : undefined,
32 
  }
33 
  const options = Object.entries(option_values ?? {})
34
35 
  const response = await fetch(
36 
    `https://${auth.store_name}.myshopify.com/admin/api/2026-10/graphql.json`,
37 
    {
38 
      method: "POST",
39 
      headers: {
40 
        "X-Shopify-Access-Token": auth.token,
41 
        "Content-Type": "application/json",
42 
        Accept: "application/json",
43 
      },
44 
      body: JSON.stringify({
45 
        query: `mutation ($productId: ID!, $variants: [ProductVariantsBulkInput!]!) { productVariantsBulkUpdate(productId: $productId, variants: $variants) { productVariants { id legacyResourceId title sku price compareAtPrice inventoryPolicy updatedAt selectedOptions { name value } barcodes(first: 5) { nodes { value type } } inventoryItem { id measurement { weight { value unit } } } } userErrors { field message code } } }`,
46 
        variables: {
47 
          productId,
48 
          variants: [
49 
            {
50 
              id,
51 
              price: price || undefined,
52 
              compareAtPrice: compare_at_price || undefined,
53 
              barcodes: barcode ? [{ value: barcode }] : undefined,
54 
              inventoryPolicy: inventory_policy || undefined,
55 
              inventoryItem:
56 
                inventoryItem.sku || inventoryItem.measurement
57 
                  ? inventoryItem
58 
                  : undefined,
59 
              optionValues: options.length
60 
                ? options.map(([optionName, name]) => ({ optionName, name }))
61 
                : undefined,
62 
            },
63 
          ],
64 
        },
65 
      }),
66 
    }
67 
  )
68
69 
  if (!response.ok) {
70 
    throw new Error(`${response.status} ${await response.text()}`)
71 
  }
72
73 
  const { data, errors } = await response.json()
74 
  if (errors) {
75 
    throw new Error(JSON.stringify(errors))
76 
  }
77 
  if (data.productVariantsBulkUpdate.userErrors.length) {
78 
    throw new Error(JSON.stringify(data.productVariantsBulkUpdate.userErrors))
79 
  }
80
81 
  return data.productVariantsBulkUpdate
82 
}
83
Other submissions
  • Submitted by hugo697 Typescript (fetch-only)
    Created 528 days ago
    All edits
    Permalink
    1 
    type Shopify = {
    2 
      token: string;
    3 
      store_name: string;
    4 
    };
    5 
    /**
    6 
     * Modify an existing Product Variant
    7 
     * Updates an existing product variant
    8 
     */
    9 
    export async function main(
    10 
      auth: Shopify,
    11 
      api_version: string = "2023-10",
    12 
      variant_id: string,
    13 
      body: {
    14 
        variant?: {
    15 
          id?: number;
    16 
          option1?: string;
    17 
          price?: string;
    18 
          [k: string]: unknown;
    19 
        };
    20 
        [k: string]: unknown;
    21 
      }
    22 
    ) {
    23 
      const url = new URL(
    24 
        `https://${auth.store_name}.myshopify.com/admin/api/${api_version}/variants/${variant_id}.json`
    25 
      );
    26
    27 
      const response = await fetch(url, {
    28 
        method: "PUT",
    29 
        headers: {
    30 
          "Content-Type": "application/json",
    31 
          "X-Shopify-Access-Token": auth.token,
    32 
        },
    33 
        body: JSON.stringify(body),
    34 
      });
    35 
      if (!response.ok) {
    36 
        const text = await response.text();
    37 
        throw new Error(`${response.status} ${text}`);
    38 
      }
    39 
      return await response.json();
    40 
    }
    41