shopLocaleUpdate mutation

Version unstable

Updates a locale for a shop.

Required access

write_locales access scope.

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.


Arguments

Argument Description
locale ( String! ) required

Specifies the locale to update.

shopLocale ( ShopLocaleInput! ) required

Specifies the input fields for a shop locale.

ShopLocaleInput fields

  • published (Boolean)

    Specifies the publication state of the locale.

Return fields

  • shopLocale (ShopLocale)

    The locale that was updated.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Updates a locale for a shop.

Required access

write_locales access scope.

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.


Arguments

Argument Description
locale ( String! ) required

Specifies the locale to update.

shopLocale ( ShopLocaleInput! ) required

Specifies the input fields for a shop locale.

ShopLocaleInput fields

  • published (Boolean)

    Specifies the publication state of the locale.

Return fields

  • shopLocale (ShopLocale)

    The locale that was updated.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Updates a locale for a shop.

Required access

write_locales access scope.

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.


Arguments

Argument Description
locale ( String! ) required

Specifies the locale to update.

shopLocale ( ShopLocaleInput! ) required

Specifies the input fields for a shop locale.

ShopLocaleInput fields

  • published (Boolean)

    Specifies the publication state of the locale.

Return fields

  • shopLocale (ShopLocale)

    The locale that was updated.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-04

Updates a locale for a shop.

Required access

write_locales access scope.

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.


Arguments

Argument Description
locale ( String! ) required

Specifies the locale to update.

shopLocale ( ShopLocaleInput! ) required

Specifies the input fields for a shop locale.

ShopLocaleInput fields

  • published (Boolean)

    Specifies the publication state of the locale.

Return fields

  • shopLocale (ShopLocale)

    The locale that was updated.