translationsRemove - admin-graphql - MUTATION

Version: 2024-10

Description:

Deletes translations.

Access Scopes

`write_translations` access scope.

Arguments

• locales: String! - The list of translation locales. Only locales returned in `shopLocales` are valid.
• marketIds: ID - The list of market IDs.
• resourceId: ID! - ID of the translatable resource for which translations are being deleted.
• translationKeys: String! - The list of translation keys.

Returns

• translations: Translation The translations that were deleted.
• userErrors: TranslationUserError! The list of errors that occurred from executing the mutation.

Examples

• Remove a French product title translation

          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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Product/20995642\",\n  \"locales\" => [\"fr\"],\n  \"translationKeys\" => [\"title\"],\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 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"
          Graphql 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}"
        

  input: {
    "resourceId": "gid://shopify/Product/20995642",
    "locales": [
      "fr"
    ],
    "translationKeys": [
      "title"
    ]
  }

  response: {
    "data": {
      "translationsRemove": {
        "userErrors": [],
        "translations": [
          {
            "key": "title",
            "value": "L'élément"
          }
        ]
      }
    }
  }

  Remove a French product title translation specific to a market

          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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

  input: {
    "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"
            }
          }
        ]
      }
    }
  }