Skip to main content
POST
/
admin
/
products
/
{id}
/
variants
/
{variant_id}
/
images
/
batch
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.product.batchVariantImages("prod_123", "variant_123", {
  add: ["img_123", "img_456"],
  remove: ["img_789"]
})
.then(({ added, removed }) => {
  console.log(added, removed)
})
{
  "added": [
    "<string>"
  ],
  "removed": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The product's ID.

​
variant_id
string
required

The product variant's ID.

Body

application/json

Details of the associations between images and a product variant to manage.

​
add
string[]

The IDs of product images to add to the variant.

The ID of the image to add.

​
remove
string[]

The IDs of product images to remove from the variant.

The ID of the image to remove.

Response

OK

Result of managing the associations between images and a product variant.

​
added
string[]
required

The IDs of product images added to the variant.

The ID of the image added.

​
removed
string[]
required

The IDs of product images removed from the variant.

The ID of the image removed.