shopLocaleDisable mutation

Version unstable

Disables 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 disable.

Return fields

  • locale (String)

    The locale identifier that was disabled.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Disables 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 disable.

Return fields

  • locale (String)

    The locale identifier that was disabled.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (Latest)

Disables 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 disable.

Return fields

  • locale (String)

    The locale identifier that was disabled.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-04

Disables 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 disable.

Return fields

  • locale (String)

    The locale identifier that was disabled.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-01

Disables 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 disable.

Return fields

  • locale (String)

    The locale identifier that was disabled.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.

Version 2020-10

Disables 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