Anchor to productCreateMediaproduct
productCreateMedia
mutationDeprecated
Requires access scope. Also: The user must have a permission to create media for a product.
Creates media for a product. Use or
instead.
Anchor to Arguments
Arguments
- Anchor to mediamedia•[Create
Media requiredInput!]! List of new media to be added to a product.
- Anchor to productIdproduct•
Id ID!required Specifies the product associated with the media.
Was this section helpful?
Anchor to ProductCreateMediaPayload returnsProductCreateMediaPayload returns
- Anchor to mediamedia•
The newly created media.
- Anchor to mediaUserErrorsmedia•
User Errors [MediaUser non-nullError!]! The list of errors that occurred from executing the mutation.
- Anchor to productproduct•
The product associated with the media.
- Anchor to userErrorsuser•
Errors 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
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"
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{
"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"
}
}
}