productDeleteMedia
mutation

Choose a version:

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

Deletes media for a product.

Anchor to section titled 'Arguments'

Arguments

Anchor to mediaIds mediaIds [ID!]! required: The media IDs to be deleted.
Anchor to productId productId ID! required: Specifies the product ID from which the media will be deleted.

Was this section helpful?

Anchor to section titled 'ProductDeleteMediaPayload returns'

ProductDeleteMediaPayload returns

Anchor to ProductDeleteMediaPayload.deletedMediaIds deletedMediaIds [ID!]: List of media IDs which were deleted.
Anchor to ProductDeleteMediaPayload.deletedProductImageIds deletedProductImageIds [ID!]: List of product image IDs which were deleted.
Anchor to ProductDeleteMediaPayload.mediaUserErrors mediaUserErrors [MediaUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to ProductDeleteMediaPayload.product product Product: The product associated with the deleted media.
Anchor to ProductDeleteMediaPayload.userErrors userErrors [UserError!]! non-null deprecated: The list of errors that occurred from executing the mutation. Use mediaUserErrors instead.

Was this section helpful?

Code examples for MUTATION: productDeleteMedia

Query Reference for MUTATION: productDeleteMedia

"mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n  productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n    deletedMediaIds\n    deletedProductImageIds\n    mediaUserErrors {\n      # MediaUserError fields\n    }\n    product {\n      # Product fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: productDeleteMedia

"{\n  \"mediaIds\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ],\n  \"productId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: productDeleteMedia

""

Display Examples for MUTATION: productDeleteMedia

[
  {
    "example": {
      "type_name": "productdeletemedia",
      "title": "Delete existing and non-existing media from a product",
      "description": "Trying to delete both existing and non-existing media from a product returns an error and the existing media is not deleted.",
      "query_string": "mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n  productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n    deletedMediaIds\n    deletedProductImageIds\n    mediaUserErrors {\n      field\n      message\n    }\n    product {\n      id\n      title\n      media(first: 5) {\n        nodes {\n          alt\n          mediaContentType\n          status\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "mediaIds": [
          "gid://shopify/Video/-1",
          "gid://shopify/Video/723685877"
        ],
        "productId": "gid://shopify/Product/108828309"
      },
      "response": {
        "data": {
          "productDeleteMedia": {
            "deletedMediaIds": null,
            "deletedProductImageIds": null,
            "mediaUserErrors": [
              {
                "field": [
                  "mediaIds"
                ],
                "message": "Media id gid://shopify/Video/-1 does not exist"
              }
            ],
            "product": {
              "id": "gid://shopify/Product/108828309",
              "title": "Draft",
              "media": {
                "nodes": [
                  {
                    "alt": "This is a video",
                    "mediaContentType": "EXTERNAL_VIDEO",
                    "status": "READY"
                  },
                  {
                    "alt": "This is a video",
                    "mediaContentType": "VIDEO",
                    "status": "READY"
                  },
                  {
                    "alt": "This is a 3d Model",
                    "mediaContentType": "MODEL_3D",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  }
                ]
              }
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_delete_media_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) { productDeleteMedia(mediaIds: $mediaIds, productId: $productId) { deletedMediaIds deletedProductImageIds mediaUserErrors { field message } product { id title media(first: 5) { nodes { alt mediaContentType status } } } } }\",\n \"variables\": {\n    \"mediaIds\": [\n      \"gid://shopify/Video/-1\",\n      \"gid://shopify/Video/723685877\"\n    ],\n    \"productId\": \"gid://shopify/Product/108828309\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"mediaIds\": [\n        \"gid://shopify/Video/-1\",\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"mediaIds\": [\"gid://shopify/Video/-1\", \"gid://shopify/Video/723685877\"],\n  \"productId\": \"gid://shopify/Product/108828309\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n      productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n        deletedMediaIds\n        deletedProductImageIds\n        mediaUserErrors {\n          field\n          message\n        }\n        product {\n          id\n          title\n          media(first: 5) {\n            nodes {\n              alt\n              mediaContentType\n              status\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"mediaIds\": [\n        \"gid://shopify/Video/-1\",\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"mediaIds\" => [\"gid://shopify/Video/-1\", \"gid://shopify/Video/723685877\"],\n  \"productId\" => \"gid://shopify/Product/108828309\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "mediaIds",
          "description": "The media IDs to be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[ID!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "mediaIds",
        "argValue": " [\"gid://shopify/Video/-1\",\"gid://shopify/Video/723685877\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "productId",
          "description": "Specifies the product ID from which the media will be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "productId",
        "argValue": " \"gid://shopify/Product/108828309\"",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "productdeletemedia",
      "title": "Delete media from a non-existent product",
      "description": "Trying to delete media from a non-existent product returns an error.",
      "query_string": "mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n  productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n    deletedMediaIds\n    deletedProductImageIds\n    mediaUserErrors {\n      field\n      message\n    }\n    product {\n      id\n      title\n      media(first: 5) {\n        nodes {\n          alt\n          mediaContentType\n          status\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "mediaIds": [
          "gid://shopify/Video/723685877"
        ],
        "productId": "gid://shopify/Product/0"
      },
      "response": {
        "data": {
          "productDeleteMedia": {
            "deletedMediaIds": null,
            "deletedProductImageIds": null,
            "mediaUserErrors": [
              {
                "field": [
                  "productId"
                ],
                "message": "Product does not exist"
              }
            ],
            "product": null
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_delete_media_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) { productDeleteMedia(mediaIds: $mediaIds, productId: $productId) { deletedMediaIds deletedProductImageIds mediaUserErrors { field message } product { id title media(first: 5) { nodes { alt mediaContentType status } } } } }\",\n \"variables\": {\n    \"mediaIds\": [\n      \"gid://shopify/Video/723685877\"\n    ],\n    \"productId\": \"gid://shopify/Product/0\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"mediaIds\": [\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/0\"\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"mediaIds\": [\"gid://shopify/Video/723685877\"],\n  \"productId\": \"gid://shopify/Product/0\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n      productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n        deletedMediaIds\n        deletedProductImageIds\n        mediaUserErrors {\n          field\n          message\n        }\n        product {\n          id\n          title\n          media(first: 5) {\n            nodes {\n              alt\n              mediaContentType\n              status\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"mediaIds\": [\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/0\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"mediaIds\" => [\"gid://shopify/Video/723685877\"],\n  \"productId\" => \"gid://shopify/Product/0\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "mediaIds",
          "description": "The media IDs to be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[ID!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "mediaIds",
        "argValue": " [\"gid://shopify/Video/723685877\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "productId",
          "description": "Specifies the product ID from which the media will be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "productId",
        "argValue": " \"gid://shopify/Product/0\"",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "productdeletemedia",
      "title": "Delete media from an existing product",
      "query_string": "mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n  productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n    deletedMediaIds\n    deletedProductImageIds\n    mediaUserErrors {\n      field\n      message\n    }\n    product {\n      id\n      title\n      media(first: 5) {\n        nodes {\n          alt\n          mediaContentType\n          status\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "mediaIds": [
          "gid://shopify/Video/723685877"
        ],
        "productId": "gid://shopify/Product/108828309"
      },
      "response": {
        "data": {
          "productDeleteMedia": {
            "deletedMediaIds": [
              "gid://shopify/Video/723685877"
            ],
            "deletedProductImageIds": [],
            "mediaUserErrors": [],
            "product": {
              "id": "gid://shopify/Product/108828309",
              "title": "Draft",
              "media": {
                "nodes": [
                  {
                    "alt": "This is a video",
                    "mediaContentType": "EXTERNAL_VIDEO",
                    "status": "READY"
                  },
                  {
                    "alt": "This is a 3d Model",
                    "mediaContentType": "MODEL_3D",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  }
                ]
              }
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_delete_media_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) { productDeleteMedia(mediaIds: $mediaIds, productId: $productId) { deletedMediaIds deletedProductImageIds mediaUserErrors { field message } product { id title media(first: 5) { nodes { alt mediaContentType status } } } } }\",\n \"variables\": {\n    \"mediaIds\": [\n      \"gid://shopify/Video/723685877\"\n    ],\n    \"productId\": \"gid://shopify/Product/108828309\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"mediaIds\": [\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"mediaIds\": [\"gid://shopify/Video/723685877\"],\n  \"productId\": \"gid://shopify/Product/108828309\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n      productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n        deletedMediaIds\n        deletedProductImageIds\n        mediaUserErrors {\n          field\n          message\n        }\n        product {\n          id\n          title\n          media(first: 5) {\n            nodes {\n              alt\n              mediaContentType\n              status\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"mediaIds\": [\n        \"gid://shopify/Video/723685877\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"mediaIds\" => [\"gid://shopify/Video/723685877\"],\n  \"productId\" => \"gid://shopify/Product/108828309\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "mediaIds",
          "description": "The media IDs to be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[ID!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "mediaIds",
        "argValue": " [\"gid://shopify/Video/723685877\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "productId",
          "description": "Specifies the product ID from which the media will be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "productId",
        "argValue": " \"gid://shopify/Product/108828309\"",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "productdeletemedia",
      "title": "Delete non-existing media from an existing product",
      "description": "Trying to delete non-existing media from a product returns an error.",
      "query_string": "mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n  productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n    deletedMediaIds\n    deletedProductImageIds\n    mediaUserErrors {\n      field\n      message\n    }\n    product {\n      id\n      title\n      media(first: 5) {\n        nodes {\n          alt\n          mediaContentType\n          status\n        }\n      }\n    }\n  }\n}",
      "variables": {
        "mediaIds": [
          "gid://shopify/Video/-1"
        ],
        "productId": "gid://shopify/Product/108828309"
      },
      "response": {
        "data": {
          "productDeleteMedia": {
            "deletedMediaIds": null,
            "deletedProductImageIds": null,
            "mediaUserErrors": [
              {
                "field": [
                  "mediaIds"
                ],
                "message": "Media id gid://shopify/Video/-1 does not exist"
              }
            ],
            "product": {
              "id": "gid://shopify/Product/108828309",
              "title": "Draft",
              "media": {
                "nodes": [
                  {
                    "alt": "This is a video",
                    "mediaContentType": "EXTERNAL_VIDEO",
                    "status": "READY"
                  },
                  {
                    "alt": "This is a video",
                    "mediaContentType": "VIDEO",
                    "status": "READY"
                  },
                  {
                    "alt": "This is a 3d Model",
                    "mediaContentType": "MODEL_3D",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  },
                  {
                    "alt": "",
                    "mediaContentType": "IMAGE",
                    "status": "READY"
                  }
                ]
              }
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_delete_media_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) { productDeleteMedia(mediaIds: $mediaIds, productId: $productId) { deletedMediaIds deletedProductImageIds mediaUserErrors { field message } product { id title media(first: 5) { nodes { alt mediaContentType status } } } } }\",\n \"variables\": {\n    \"mediaIds\": [\n      \"gid://shopify/Video/-1\"\n    ],\n    \"productId\": \"gid://shopify/Product/108828309\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"mediaIds\": [\n        \"gid://shopify/Video/-1\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"mediaIds\": [\"gid://shopify/Video/-1\"],\n  \"productId\": \"gid://shopify/Product/108828309\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n      productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n        deletedMediaIds\n        deletedProductImageIds\n        mediaUserErrors {\n          field\n          message\n        }\n        product {\n          id\n          title\n          media(first: 5) {\n            nodes {\n              alt\n              mediaContentType\n              status\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"mediaIds\": [\n        \"gid://shopify/Video/-1\"\n      ],\n      \"productId\": \"gid://shopify/Product/108828309\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteMedia($mediaIds: [ID!]!, $productId: ID!) {\n    productDeleteMedia(mediaIds: $mediaIds, productId: $productId) {\n      deletedMediaIds\n      deletedProductImageIds\n      mediaUserErrors {\n        field\n        message\n      }\n      product {\n        id\n        title\n        media(first: 5) {\n          nodes {\n            alt\n            mediaContentType\n            status\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"mediaIds\" => [\"gid://shopify/Video/-1\"],\n  \"productId\" => \"gid://shopify/Product/108828309\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "mediaIds",
          "description": "The media IDs to be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[ID!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "mediaIds",
        "argValue": " [\"gid://shopify/Video/-1\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "productId",
          "description": "Specifies the product ID from which the media will be deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "productId",
        "argValue": " \"gid://shopify/Product/108828309\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

productDeleteMediamutation

Arguments

ProductDeleteMediaPayload returns

productDeleteMedia
mutation