productAppendImages - admin-graphql - MUTATION

Version: 2024-04

Description:

Appends images to a product.

Access Scopes

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

Arguments

• input: ProductAppendImagesInput! - Specifies the new images and the product that they're being added to.

Returns

• newImages: Image List of new images appended to the product.
• product: Product The product object.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Append a non-existent image and an existing image to a product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productAppendImages($input: ProductAppendImagesInput!) { productAppendImages(input: $input) { newImages { id altText } product { id } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Product/108828309\",\n      \"images\": [\n        {\n          \"altText\": \"Non-existent image.\",\n          \"src\": \"fake\"\n        },\n        {\n          \"altText\": \"Existing image.\",\n          \"src\": \"http://example.com/rails_logo.gif\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productAppendImages($input: ProductAppendImagesInput!) {\n      productAppendImages(input: $input) {\n        newImages {\n          id\n          altText\n        }\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"Non-existent image.\",\n            \"src\": \"fake\"\n          },\n          {\n            \"altText\": \"Existing image.\",\n            \"src\": \"http://example.com/rails_logo.gif\"\n          }\n        ]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Product/108828309\",\n    \"images\": [{\"altText\"=>\"Non-existent image.\", \"src\"=>\"fake\"}, {\"altText\"=>\"Existing image.\", \"src\"=>\"http://example.com/rails_logo.gif\"}]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/Product/108828309\",\n    \"images\" => [{\"altText\"=>\"Non-existent image.\", \"src\"=>\"fake\"}, {\"altText\"=>\"Existing image.\", \"src\"=>\"http://example.com/rails_logo.gif\"}],\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"Non-existent image.\",\n            \"src\": \"fake\"\n          },\n          {\n            \"altText\": \"Existing image.\",\n            \"src\": \"http://example.com/rails_logo.gif\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productAppendImages($input: ProductAppendImagesInput!) {\n  productAppendImages(input: $input) {\n    newImages {\n      id\n      altText\n    }\n    product {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "id": "gid://shopify/Product/108828309",
      "images": [
        {
          "altText": "Non-existent image.",
          "src": "fake"
        },
        {
          "altText": "Existing image.",
          "src": "http://example.com/rails_logo.gif"
        }
      ]
    }
  }

  response: {
    "data": {
      "productAppendImages": {
        "newImages": [
          {
            "id": "gid://shopify/ProductImage/1001473906",
            "altText": "Existing image."
          }
        ],
        "product": {
          "id": "gid://shopify/Product/108828309"
        },
        "userErrors": [
          {
            "field": [
              "images",
              "0"
            ],
            "message": "Image URL is invalid"
          }
        ]
      }
    }
  }

  Append a non-existent image to a product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productAppendImages($input: ProductAppendImagesInput!) { productAppendImages(input: $input) { newImages { id altText } product { id } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Product/108828309\",\n      \"images\": [\n        {\n          \"altText\": \"New image description.\",\n          \"src\": \"fake\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productAppendImages($input: ProductAppendImagesInput!) {\n      productAppendImages(input: $input) {\n        newImages {\n          id\n          altText\n        }\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"New image description.\",\n            \"src\": \"fake\"\n          }\n        ]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Product/108828309\",\n    \"images\": [{\"altText\"=>\"New image description.\", \"src\"=>\"fake\"}]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/Product/108828309\",\n    \"images\" => [{\"altText\"=>\"New image description.\", \"src\"=>\"fake\"}],\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"New image description.\",\n            \"src\": \"fake\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productAppendImages($input: ProductAppendImagesInput!) {\n  productAppendImages(input: $input) {\n    newImages {\n      id\n      altText\n    }\n    product {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "id": "gid://shopify/Product/108828309",
      "images": [
        {
          "altText": "New image description.",
          "src": "fake"
        }
      ]
    }
  }

  response: {
    "data": {
      "productAppendImages": {
        "newImages": [],
        "product": {
          "id": "gid://shopify/Product/108828309"
        },
        "userErrors": [
          {
            "field": [
              "images",
              "0"
            ],
            "message": "Image URL is invalid"
          }
        ]
      }
    }
  }

  Append an image to a product

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productAppendImages($input: ProductAppendImagesInput!) { productAppendImages(input: $input) { newImages { id altText } product { id } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Product/108828309\",\n      \"images\": [\n        {\n          \"altText\": \"New image description.\",\n          \"src\": \"http://example.com/rails_logo.gif\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productAppendImages($input: ProductAppendImagesInput!) {\n      productAppendImages(input: $input) {\n        newImages {\n          id\n          altText\n        }\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"New image description.\",\n            \"src\": \"http://example.com/rails_logo.gif\"\n          }\n        ]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Product/108828309\",\n    \"images\": [{\"altText\"=>\"New image description.\", \"src\"=>\"http://example.com/rails_logo.gif\"}]\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/Product/108828309\",\n    \"images\" => [{\"altText\"=>\"New image description.\", \"src\"=>\"http://example.com/rails_logo.gif\"}],\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 productAppendImages($input: ProductAppendImagesInput!) {\n    productAppendImages(input: $input) {\n      newImages {\n        id\n        altText\n      }\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\",\n        \"images\": [\n          {\n            \"altText\": \"New image description.\",\n            \"src\": \"http://example.com/rails_logo.gif\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productAppendImages($input: ProductAppendImagesInput!) {\n  productAppendImages(input: $input) {\n    newImages {\n      id\n      altText\n    }\n    product {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "id": "gid://shopify/Product/108828309",
      "images": [
        {
          "altText": "New image description.",
          "src": "http://example.com/rails_logo.gif"
        }
      ]
    }
  }

  response: {
    "data": {
      "productAppendImages": {
        "newImages": [
          {
            "id": "gid://shopify/ProductImage/1001473904",
            "altText": "New image description."
          }
        ],
        "product": {
          "id": "gid://shopify/Product/108828309"
        },
        "userErrors": []
      }
    }
  }