productDeleteImages - admin-graphql - MUTATION

Version: 2024-07

Description:

Removes product images from the product.

Access Scopes

`write_products` access scope. Also: The user must have a permission to remove images from a product.

Arguments

• id: ID! - This is the ID of the product.
• imageIds: ID! - This is the array of image IDs to delete from the product.

Returns

• deletedImageIds: ID! The array of image IDs to delete.
• product: Product The product object.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Delete an image from a non-existing product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) { productDeleteImages(id: $id, imageIds: $imageIds) { deletedImageIds product { id title images(first: 5) { nodes { id } } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/0\",\n    \"imageIds\": [\n      \"gid://shopify/ProductImage/183532652\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n      productDeleteImages(id: $id, imageIds: $imageIds) {\n        deletedImageIds\n        product {\n          id\n          title\n          images(first: 5) {\n            nodes {\n              id\n            }\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Product/0\",\n      \"imageIds\": [\n        \"gid://shopify/ProductImage/183532652\"\n      ]\n    },\n  },\n});\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 productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Product/0\",\n  \"imageIds\": [\"gid://shopify/ProductImage/183532652\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Product/0\",\n  \"imageIds\" => [\"gid://shopify/ProductImage/183532652\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Product/0\",\n      \"imageIds\": [\n        \"gid://shopify/ProductImage/183532652\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n  productDeleteImages(id: $id, imageIds: $imageIds) {\n    deletedImageIds\n    product {\n      id\n      title\n      images(first: 5) {\n        nodes {\n          id\n        }\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Product/0",
    "imageIds": [
      "gid://shopify/ProductImage/183532652"
    ]
  }

  response: {
    "data": {
      "productDeleteImages": {
        "deletedImageIds": [],
        "product": null,
        "userErrors": [
          {
            "field": [
              "id"
            ],
            "message": "Product does not exist"
          }
        ]
      }
    }
  }

  Delete an image from an existing product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) { productDeleteImages(id: $id, imageIds: $imageIds) { deletedImageIds product { id title images(first: 5) { nodes { id } } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Product/108828309\",\n    \"imageIds\": [\n      \"gid://shopify/ProductImage/183532652\"\n    ]\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n      productDeleteImages(id: $id, imageIds: $imageIds) {\n        deletedImageIds\n        product {\n          id\n          title\n          images(first: 5) {\n            nodes {\n              id\n            }\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Product/108828309\",\n      \"imageIds\": [\n        \"gid://shopify/ProductImage/183532652\"\n      ]\n    },\n  },\n});\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 productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Product/108828309\",\n  \"imageIds\": [\"gid://shopify/ProductImage/183532652\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Product/108828309\",\n  \"imageIds\" => [\"gid://shopify/ProductImage/183532652\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n    productDeleteImages(id: $id, imageIds: $imageIds) {\n      deletedImageIds\n      product {\n        id\n        title\n        images(first: 5) {\n          nodes {\n            id\n          }\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Product/108828309\",\n      \"imageIds\": [\n        \"gid://shopify/ProductImage/183532652\"\n      ]\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productDeleteImages($id: ID!, $imageIds: [ID!]!) {\n  productDeleteImages(id: $id, imageIds: $imageIds) {\n    deletedImageIds\n    product {\n      id\n      title\n      images(first: 5) {\n        nodes {\n          id\n        }\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Product/108828309",
    "imageIds": [
      "gid://shopify/ProductImage/183532652"
    ]
  }

  response: {
    "data": {
      "productDeleteImages": {
        "deletedImageIds": [
          "gid://shopify/ProductImage/183532652"
        ],
        "product": {
          "id": "gid://shopify/Product/108828309",
          "title": "Draft",
          "images": {
            "nodes": [
              {
                "id": "gid://shopify/ProductImage/731367280"
              }
            ]
          }
        },
        "userErrors": []
      }
    }
  }