productCreateMedia

mutationDeprecated

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

Creates media for a product. Use productUpdate or productSet instead.

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?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation productCreateMedia($media: [CreateMediaInput!]!, $productId: ID!) {
6    productCreateMedia(media: $media, productId: $productId) {
7      media {
8        alt
9        mediaContentType
10        status
11      }
12      mediaUserErrors {
13        field
14        message
15      }
16      product {
17        id
18        title
19      }
20    }
21  }`,
22  {
23    variables: {
24      "media": [
25        {
26          "alt": "Image",
27          "mediaContentType": "EXTERNAL_VIDEO",
28          "originalSource": "https://youtu.be/32mGBDk3LSo"
29        },
30        {
31          "alt": "Image",
32          "mediaContentType": "IMAGE",
33          "originalSource": "invalid_img"
34        }
35      ],
36      "productId": "gid://shopify/Product/121709582"
37    },
38  },
39);
40
41const data = await response.json();
42

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-01/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

1{
2  "media": [
3    {
4      "alt": "Image",
5      "mediaContentType": "EXTERNAL_VIDEO",
6      "originalSource": "https://youtu.be/32mGBDk3LSo"
7    },
8    {
9      "alt": "Image",
10      "mediaContentType": "IMAGE",
11      "originalSource": "invalid_img"
12    }
13  ],
14  "productId": "gid://shopify/Product/121709582"
15}

Response

JSON

1{
2  "productCreateMedia": {
3    "media": [
4      {
5        "alt": "Image",
6        "mediaContentType": "EXTERNAL_VIDEO",
7        "status": "UPLOADED"
8      }
9    ],
10    "mediaUserErrors": [
11      {
12        "field": [
13          "media",
14          "1",
15          "originalSource"
16        ],
17        "message": "Image URL is invalid"
18      }
19    ],
20    "product": {
21      "id": "gid://shopify/Product/121709582",
22      "title": "Boots"
23    }
24  }
25}