shopLocaleUpdate mutation

Updates a locale for a shop.

Required access

write_locales access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation shopLocaleUpdate($locale: String!, $shopLocale: ShopLocaleInput!) { shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) { 
  1. <font style="color:#1F61A0;">shopLocale</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">locale</font>
  5.   <font style="color:#1F61A0;">name</font>
  7.   <font style="color:#1F61A0;">primary</font>
  9.   <font style="color:#1F61A0;">published</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <font style="color:#555555;">}</font>
} } { “locale”: “placeholder”, “shopLocale”: {} }

Arguments

Argument Description
locale
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 Specifies the locale to update.
shopLocale
(
[ShopLocaleInput!](https://shopify.dev/docs/admin-api/graphql/reference/translations/shoplocaleinput)

) REQUIRED		 Specifies the input fields for a shop locale.

ShopLocaleInput fields

  • published ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Specifies the publication state of the locale.

Return fields

  • shopLocale ([ShopLocale](https://shopify.dev/docs/admin-api/graphql/reference/translations/shoplocale))
    The locale that was updated.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.