translationsRemove

mutation

Requires write_translations access scope.

Deletes translations.

Arguments

Anchor to localeslocales • [String!]!required: The list of translation locales. Only locales returned in shopLocales are valid.
Anchor to marketIdsmarketIds • [ID!]: The list of market IDs.
Anchor to resourceIdresourceId • ID!required: ID of the translatable resource for which translations are being deleted.
Anchor to translationKeystranslationKeys • [String!]!required: The list of translation keys.

Was this section helpful?

Anchor to TranslationsRemovePayload returnsTranslationsRemovePayload returns

Anchor to translationstranslations • [Translation!]: The translations that were deleted.
Anchor to userErrorsuserErrors • [TranslationUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
6    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {
7      userErrors {
8        message
9        field
10      }
11      translations {
12        key
13        value
14      }
15    }
16  }`,
17  {
18    variables: {
19      "resourceId": "gid://shopify/Product/20995642",
20      "locales": [
21        "fr"
22      ],
23      "translationKeys": [
24        "title"
25      ]
26    },
27  },
28);
29
30const data = await response.json();
31

mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
  translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {
    userErrors {
      message
      field
    }
    translations {
      key
      value
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) { translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) { userErrors { message field } translations { key value } } }",
 "variables": {
    "resourceId": "gid://shopify/Product/20995642",
    "locales": [
      "fr"
    ],
    "translationKeys": [
      "title"
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {
      userErrors {
        message
        field
      }
      translations {
        key
        value
      }
    }
  }`,
  {
    variables: {
      "resourceId": "gid://shopify/Product/20995642",
      "locales": [
        "fr"
      ],
      "translationKeys": [
        "title"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
      translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {
        userErrors {
          message
          field
        }
        translations {
          key
          value
        }
      }
    }`,
    "variables": {
      "resourceId": "gid://shopify/Product/20995642",
      "locales": [
        "fr"
      ],
      "translationKeys": [
        "title"
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
    translationsRemove(resourceId: $resourceId, translationKeys: $translationKeys, locales: $locales) {
      userErrors {
        message
        field
      }
      translations {
        key
        value
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "resourceId": "gid://shopify/Product/20995642",
3  "locales": [
4    "fr"
5  ],
6  "translationKeys": [
7    "title"
8  ]
9}

Response

JSON

1{
2  "translationsRemove": {
3    "userErrors": [],
4    "translations": [
5      {
6        "key": "title",
7        "value": "L'élément"
8      }
9    ]
10  }
11}