Anchor to section titled 'undefined'

marketCurrencySettingsUpdate
mutation

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

Updates currency settings of a market.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
MarketCurrencySettingsUpdateInput!
required

Properties to update for the market currency settings.

Anchor to marketId
marketId
ID!
required

The ID of the market definition to target.

Was this section helpful?
Anchor to section titled 'MarketCurrencySettingsUpdatePayload returns'

MarketCurrencySettingsUpdatePayload returns

Anchor to MarketCurrencySettingsUpdatePayload.market
market
Market

The market object.

Anchor to MarketCurrencySettingsUpdatePayload.userErrors
userErrors
[MarketCurrencySettingsUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation marketCurrencySettingsUpdate($input: MarketCurrencySettingsUpdateInput!, $marketId: ID!) {
  marketCurrencySettingsUpdate(input: $input, marketId: $marketId) {
    market {
      # Market fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "baseCurrency": "AED",
    "localCurrencies": true
  },
  "marketId": "gid://shopify/<objectName>/10079785100"
}
input MarketCurrencySettingsUpdateInput {
  baseCurrency: CurrencyCode
  localCurrencies: Boolean
}