Choose a version:

productCreateMedia

mutation

Requires write_products access scope. Also: The user must have a permission to create media for a product.

Deprecated. Use `productUpdate` or `productSet` instead.

Creates media for a product.

Arguments

Anchor to mediamedia • [CreateMediaInput!]!required: List of new media to be added to a product.
Anchor to productIdproductId • ID!required: Specifies the product associated with the media.

Was this section helpful?

Anchor to ProductCreateMediaPayload returnsProductCreateMediaPayload returns

Anchor to mediamedia • [Media!]: The newly created media.
Anchor to mediaUserErrorsmediaUserErrors • [MediaUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to productproduct • Product: The product associated with the media.
Anchor to userErrorsuserErrors • [UserError!]!non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Add both valid and invalid media to an existing product
Add invalid media to an existing product
Add new media to a non-existent product
Add new media to an existing product
Create a new Product Image
productCreateMedia reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {

productCreateMedia(media: $media, productId: $productId) {

media {

alt

mediaContentType

status

}

mediaUserErrors {

field

message

}

product {

title

}

}`,

{

variables: {

"media": [

{

"alt": "Image",

"mediaContentType": "EXTERNAL_VIDEO",

"originalSource": "https://youtu.be/32mGBDk3LSo"

{

"alt": "Image",

"mediaContentType": "IMAGE",

"originalSource": "invalid_img"

}

"productId": "gid://shopify/Product/121709582"

);

const data = await response.json();

mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {
  productCreateMedia(media: $media, productId: $productId) {
    media {
      alt
      mediaContentType
      status
    }
    mediaUserErrors {
      field
      message
    }
    product {
      id
      title
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) { productCreateMedia(media: $media, productId: $productId) { media { alt mediaContentType status } mediaUserErrors { field message } product { id title } } }",
 "variables": {
    "media": [
      {
        "alt": "Image",
        "mediaContentType": "EXTERNAL_VIDEO",
        "originalSource": "https://youtu.be/32mGBDk3LSo"
      },
      {
        "alt": "Image",
        "mediaContentType": "IMAGE",
        "originalSource": "invalid_img"
      }
    ],
    "productId": "gid://shopify/Product/121709582"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {
    productCreateMedia(media: $media, productId: $productId) {
      media {
        alt
        mediaContentType
        status
      }
      mediaUserErrors {
        field
        message
      }
      product {
        id
        title
      }
    }
  }`,
  {
    variables: {
      "media": [
        {
          "alt": "Image",
          "mediaContentType": "EXTERNAL_VIDEO",
          "originalSource": "https://youtu.be/32mGBDk3LSo"
        },
        {
          "alt": "Image",
          "mediaContentType": "IMAGE",
          "originalSource": "invalid_img"
        }
      ],
      "productId": "gid://shopify/Product/121709582"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {
      productCreateMedia(media: $media, productId: $productId) {
        media {
          alt
          mediaContentType
          status
        }
        mediaUserErrors {
          field
          message
        }
        product {
          id
          title
        }
      }
    }`,
    "variables": {
      "media": [
        {
          "alt": "Image",
          "mediaContentType": "EXTERNAL_VIDEO",
          "originalSource": "https://youtu.be/32mGBDk3LSo"
        },
        {
          "alt": "Image",
          "mediaContentType": "IMAGE",
          "originalSource": "invalid_img"
        }
      ],
      "productId": "gid://shopify/Product/121709582"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {
    productCreateMedia(media: $media, productId: $productId) {
      media {
        alt
        mediaContentType
        status
      }
      mediaUserErrors {
        field
        message
      }
      product {
        id
        title
      }
    }
  }
QUERY

variables = {
  "media": [{"alt"=>"Image", "mediaContentType"=>"EXTERNAL_VIDEO", "originalSource"=>"https://youtu.be/32mGBDk3LSo"}, {"alt"=>"Image", "mediaContentType"=>"IMAGE", "originalSource"=>"invalid_img"}],
  "productId": "gid://shopify/Product/121709582"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"media": [

{

"alt": "Image",

"mediaContentType": "EXTERNAL_VIDEO",

"originalSource": "https://youtu.be/32mGBDk3LSo"

{

"alt": "Image",

"mediaContentType": "IMAGE",

"originalSource": "invalid_img"

}

"productId": "gid://shopify/Product/121709582"

}

Response

JSON

{

"productCreateMedia": {

"media": [

{

"alt": "Image",

"mediaContentType": "EXTERNAL_VIDEO",

"status": "UPLOADED"

}

"mediaUserErrors": [

{

"field": [

"media",

"1",

"originalSource"

"message": "Image URL is invalid"

}

"product": {

"id": "gid://shopify/Product/121709582",

"title": "Boots"

}