translationsRemove

mutation

Code examples for MUTATION: translationsRemove

Query Reference for MUTATION: translationsRemove

"mutation translationsRemove($locales: [String!]!, $resourceId: ID!, $translationKeys: [String!]!) {\n  translationsRemove(locales: $locales, resourceId: $resourceId, translationKeys: $translationKeys) {\n    translations {\n      # Translation fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: translationsRemove

"{\n  \"locales\": [\n    \"<your-locales>\"\n  ],\n  \"marketIds\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ],\n  \"resourceId\": \"gid://shopify/<objectName>/10079785100\",\n  \"translationKeys\": [\n    \"<your-translationKeys>\"\n  ]\n}"

Schema Reference for MUTATION: translationsRemove

""

Display Examples for MUTATION: translationsRemove

[
  {
    "example": {
      "type_name": "translationsremove",
      "title": "Remove a French product title translation",
      "description": "Translations matching all of the inputs will be removed. In this example, we are removing the product title's French translation that is not specific to any market.",
      "query_string": "mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {\n  translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {\n    userErrors {\n      message\n      field\n    }\n    translations {\n      key\n      value\n    }\n  }\n}",
      "query_arguments": {
        "resourceId": "$resourceId",
        "translationKeys": "$translationKeys",
        "locales": "$locales"
      },
      "variables": {
        "resourceId": "gid://shopify/Product/20995642",
        "locales": [
          "fr"
        ],
        "translationKeys": [
          "title"
        ]
      },
      "response": {
        "data": {
          "translationsRemove": {
            "userErrors": [],
            "translations": [
              {
                "key": "title",
                "value": "L'élément"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/markets/store_localization/test/unit/graph_api/admin/mutations/translations_remove_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) { translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) { userErrors { message field } translations { key value } } }\",\n \"variables\": {\n    \"resourceId\": \"gid://shopify/Product/20995642\",\n    \"locales\": [\n      \"fr\"\n    ],\n    \"translationKeys\": [\n      \"title\"\n    ]\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"resourceId\": \"gid://shopify/Product/20995642\",\n      \"locales\": [\n        \"fr\"\n      ],\n      \"translationKeys\": [\n        \"title\"\n      ]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"resourceId\": \"gid://shopify/Product/20995642\",\n  \"locales\": [\"fr\"],\n  \"translationKeys\": [\"title\"]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {\n      translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {\n        userErrors {\n          message\n          field\n        }\n        translations {\n          key\n          value\n        }\n      }\n    }`,\n    \"variables\": {\n      \"resourceId\": \"gid://shopify/Product/20995642\",\n      \"locales\": [\n        \"fr\"\n      ],\n      \"translationKeys\": [\n        \"title\"\n      ]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"resourceId\" => \"gid://shopify/Product/20995642\",\n  \"locales\" => [\"fr\"],\n  \"translationKeys\" => [\"title\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "resourceId",
          "description": "ID of the translatable resource for which translations are being deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "resourceId",
        "argValue": " \"gid://shopify/Product/20995642\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "locales",
          "description": "The list of translation locales. Only locales returned in `shopLocales` are valid.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[String!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "locales",
        "argValue": " [\"fr\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "translationKeys",
          "description": "The list of translation keys.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[String!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "translationKeys",
        "argValue": " [\"title\"]",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "translationsremove",
      "title": "Remove a French product title translation specific to a market",
      "description": "To remove content that surfaces only to buyers in specific markets, make use of the optional `marketIds` argument. In this example, the targeted market has an ID of `gid://shopify/Market/128989799`.",
      "query_string": "mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) {\n  translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) {\n    userErrors {\n      message\n      field\n    }\n    translations {\n      key\n      value\n      market {\n        id\n      }\n    }\n  }\n}",
      "query_arguments": {
        "resourceId": "$resourceId",
        "translationKeys": "$translationKeys",
        "locales": "$locales",
        "marketIds": "$marketIds"
      },
      "variables": {
        "resourceId": "gid://shopify/Product/20995642",
        "locales": [
          "fr"
        ],
        "translationKeys": [
          "title"
        ],
        "marketIds": [
          "gid://shopify/Market/128989799"
        ]
      },
      "response": {
        "data": {
          "translationsRemove": {
            "userErrors": [],
            "translations": [
              {
                "key": "title",
                "value": "L'élément canadien",
                "market": {
                  "id": "gid://shopify/Market/128989799"
                }
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/markets/store_localization/test/unit/graph_api/admin/mutations/translations_remove_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) { translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) { userErrors { message field } translations { key value market { id } } } }\",\n \"variables\": {\n    \"resourceId\": \"gid://shopify/Product/20995642\",\n    \"locales\": [\n      \"fr\"\n    ],\n    \"translationKeys\": [\n      \"title\"\n    ],\n    \"marketIds\": [\n      \"gid://shopify/Market/128989799\"\n    ]\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n        market {\n          id\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"resourceId\": \"gid://shopify/Product/20995642\",\n      \"locales\": [\n        \"fr\"\n      ],\n      \"translationKeys\": [\n        \"title\"\n      ],\n      \"marketIds\": [\n        \"gid://shopify/Market/128989799\"\n      ]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n        market {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"resourceId\": \"gid://shopify/Product/20995642\",\n  \"locales\": [\"fr\"],\n  \"translationKeys\": [\"title\"],\n  \"marketIds\": [\"gid://shopify/Market/128989799\"]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) {\n      translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) {\n        userErrors {\n          message\n          field\n        }\n        translations {\n          key\n          value\n          market {\n            id\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"resourceId\": \"gid://shopify/Product/20995642\",\n      \"locales\": [\n        \"fr\"\n      ],\n      \"translationKeys\": [\n        \"title\"\n      ],\n      \"marketIds\": [\n        \"gid://shopify/Market/128989799\"\n      ]\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 translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!, $marketIds: [ID!]) {\n    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales, marketIds: $marketIds) {\n      userErrors {\n        message\n        field\n      }\n      translations {\n        key\n        value\n        market {\n          id\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"resourceId\" => \"gid://shopify/Product/20995642\",\n  \"locales\" => [\"fr\"],\n  \"translationKeys\" => [\"title\"],\n  \"marketIds\" => [\"gid://shopify/Market/128989799\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "resourceId",
          "description": "ID of the translatable resource for which translations are being deleted.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "resourceId",
        "argValue": " \"gid://shopify/Product/20995642\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "locales",
          "description": "The list of translation locales. Only locales returned in `shopLocales` are valid.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[String!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "locales",
        "argValue": " [\"fr\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "translationKeys",
          "description": "The list of translation keys.",
          "type": {
            "kind": "SCALAR",
            "name": "String",
            "list": true,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "[String!]!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "translationKeys",
        "argValue": " [\"title\"]",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "marketIds",
          "description": "The list of market IDs.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": true,
            "non_null": false
          },
          "defaultValue": null,
          "typeSignature": "[ID!]",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "marketIds",
        "argValue": " [\"gid://shopify/Market/128989799\"]",
        "typeKind": "MUTATION"
      }
    ]
  }
]