productImageUpdate - admin-graphql - MUTATION

Version: 2024-07

Description:

Updates an image of a product.

Access Scopes

`write_products` access scope. Also: The user must have a permission to update an image of a product.

Arguments

• image: ImageInput! - Image to be updated.
• productId: ID! - The ID of the product on which to update the image.

Returns

• image: Image The image that has been updated.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Update a product's image

          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 productImageUpdate($productId: ID!, $image: ImageInput!) { productImageUpdate(productId: $productId, image: $image) { image { id altText src } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/108828309\",\n    \"image\": {\n      \"id\": \"gid://shopify/ProductImage/183532652\",\n      \"altText\": \"New image description.\",\n      \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n      productImageUpdate(productId: $productId, image: $image) {\n        image {\n          id\n          altText\n          src\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/183532652\",\n        \"altText\": \"New image description.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/108828309\",\n  \"image\": {\n    \"id\": \"gid://shopify/ProductImage/183532652\",\n    \"altText\": \"New image description.\",\n    \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n  }\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/108828309\",\n  \"image\" => [\n    \"id\" => \"gid://shopify/ProductImage/183532652\",\n    \"altText\" => \"New image description.\",\n    \"src\" => \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\",\n  ],\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/183532652\",\n        \"altText\": \"New image description.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n  productImageUpdate(productId: $productId, image: $image) {\n    image {\n      id\n      altText\n      src\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/108828309",
    "image": {
      "id": "gid://shopify/ProductImage/183532652",
      "altText": "New image description.",
      "src": "https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124"
    }
  }

  response: {
    "data": {
      "productImageUpdate": {
        "image": {
          "id": "gid://shopify/ProductImage/183532652",
          "altText": "New image description.",
          "src": "https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124"
        },
        "userErrors": []
      }
    }
  }

  Update an image of a non-existent 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 productImageUpdate($productId: ID!, $image: ImageInput!) { productImageUpdate(productId: $productId, image: $image) { image { id altText src } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/-1\",\n    \"image\": {\n      \"id\": \"gid://shopify/ProductImage/183532652\",\n      \"altText\": \"New image description.\",\n      \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n      productImageUpdate(productId: $productId, image: $image) {\n        image {\n          id\n          altText\n          src\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/-1\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/183532652\",\n        \"altText\": \"New image description.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/-1\",\n  \"image\": {\n    \"id\": \"gid://shopify/ProductImage/183532652\",\n    \"altText\": \"New image description.\",\n    \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n  }\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/-1\",\n  \"image\" => [\n    \"id\" => \"gid://shopify/ProductImage/183532652\",\n    \"altText\" => \"New image description.\",\n    \"src\" => \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\",\n  ],\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/-1\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/183532652\",\n        \"altText\": \"New image description.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n  productImageUpdate(productId: $productId, image: $image) {\n    image {\n      id\n      altText\n      src\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/-1",
    "image": {
      "id": "gid://shopify/ProductImage/183532652",
      "altText": "New image description.",
      "src": "https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124"
    }
  }

  response: {
    "data": {
      "productImageUpdate": {
        "image": null,
        "userErrors": [
          {
            "field": [
              "productId"
            ],
            "message": "Product does not exist"
          }
        ]
      }
    }
  }

  Update the product with a non-existent image

          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 productImageUpdate($productId: ID!, $image: ImageInput!) { productImageUpdate(productId: $productId, image: $image) { image { id altText src } userErrors { field message } } }\",\n \"variables\": {\n    \"productId\": \"gid://shopify/Product/108828309\",\n    \"image\": {\n      \"id\": \"gid://shopify/ProductImage/0\",\n      \"altText\": \"An image with this ID doesn'\\''t exist.\",\n      \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n      productImageUpdate(productId: $productId, image: $image) {\n        image {\n          id\n          altText\n          src\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/0\",\n        \"altText\": \"An image with this ID doesn't exist.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"productId\": \"gid://shopify/Product/108828309\",\n  \"image\": {\n    \"id\": \"gid://shopify/ProductImage/0\",\n    \"altText\": \"An image with this ID doesn't exist.\",\n    \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n  }\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"productId\" => \"gid://shopify/Product/108828309\",\n  \"image\" => [\n    \"id\" => \"gid://shopify/ProductImage/0\",\n    \"altText\" => \"An image with this ID doesn't exist.\",\n    \"src\" => \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\",\n  ],\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 productImageUpdate($productId: ID!, $image: ImageInput!) {\n    productImageUpdate(productId: $productId, image: $image) {\n      image {\n        id\n        altText\n        src\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"productId\": \"gid://shopify/Product/108828309\",\n      \"image\": {\n        \"id\": \"gid://shopify/ProductImage/0\",\n        \"altText\": \"An image with this ID doesn't exist.\",\n        \"src\": \"https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productImageUpdate($productId: ID!, $image: ImageInput!) {\n  productImageUpdate(productId: $productId, image: $image) {\n    image {\n      id\n      altText\n      src\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "productId": "gid://shopify/Product/108828309",
    "image": {
      "id": "gid://shopify/ProductImage/0",
      "altText": "An image with this ID doesn't exist.",
      "src": "https://cdn.shopify.com/s/files/1/2637/1970/products/draft58.jpg?v=1726103124"
    }
  }

  response: {
    "data": {
      "productImageUpdate": {
        "image": null,
        "userErrors": [
          {
            "field": [
              "image",
              "id"
            ],
            "message": "Image does not exist"
          }
        ]
      }
    }
  }