CurrencyFormats - admin-graphql - OBJECT

Version: 2024-07

Description:

Currency formats configured for the merchant. These formats are available to use within Liquid.

Access Scopes

Fields

• moneyFormat: FormattedString! - Money without currency in HTML.
• moneyInEmailsFormat: String! - Money without currency in emails.
• moneyWithCurrencyFormat: FormattedString! - Money with currency in HTML.
• moneyWithCurrencyInEmailsFormat: String! - Money with currency in emails.

Connections

Related queries

Related mutations

Related Unions

Examples

• Retrieve all currency formats on a shop

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { currencyFormats { moneyFormat moneyWithCurrencyFormat moneyInEmailsFormat moneyWithCurrencyInEmailsFormat } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      currencyFormats {\n        moneyFormat\n        moneyWithCurrencyFormat\n        moneyInEmailsFormat\n        moneyWithCurrencyInEmailsFormat\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shop {\n      currencyFormats {\n        moneyFormat\n        moneyWithCurrencyFormat\n        moneyInEmailsFormat\n        moneyWithCurrencyInEmailsFormat\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    shop {\n      currencyFormats {\n        moneyFormat\n        moneyWithCurrencyFormat\n        moneyInEmailsFormat\n        moneyWithCurrencyInEmailsFormat\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      currencyFormats {\n        moneyFormat\n        moneyWithCurrencyFormat\n        moneyInEmailsFormat\n        moneyWithCurrencyInEmailsFormat\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    currencyFormats {\n      moneyFormat\n      moneyWithCurrencyFormat\n      moneyInEmailsFormat\n      moneyWithCurrencyInEmailsFormat\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "currencyFormats": {
          "moneyFormat": "${{amount}}",
          "moneyWithCurrencyFormat": "${{amount}} USD",
          "moneyInEmailsFormat": "${{amount}}",
          "moneyWithCurrencyInEmailsFormat": "${{amount}} USD"
        }
      }
    }
  }