Currency

A currency known to the shop. Used as the unit for monetary scalars and as the per-sales-channel default currency.

type Currency implements Node {
  id: ID!
  factor: Float!
  symbol: String!
  isoCode: String!
  shortName: String
  name: String
  position: Int
  isDefaultCurrency: Boolean!
  salesChannelDefaultAssignments(
    first: Int = 10
    after: String
    filter: SalesChannelFilterInput
  ): SalesChannelConnection
  orders(
    first: Int = 10
    after: String
    filter: OrderFilterInput
  ): OrderConnection
  salesChannels(
    first: Int = 10
    after: String
    filter: SalesChannelFilterInput
  ): SalesChannelConnection
}

Fields

`Currency.id` ● `ID!` non-null scalar

Global identifier for this entity.

`Currency.factor` ● `Float!` non-null scalar

Conversion factor relative to the default currency. 1.0 for the default itself.

`Currency.symbol` ● `String!` non-null scalar

Currency symbol used when rendering prices (e.g. €, $).

`Currency.isoCode` ● `String!` non-null scalar

ISO 4217 currency code (e.g. EUR, USD). Stable across locales.

`Currency.shortName` ● `String` scalar

Short display label. Localised, so may diverge from isoCode.

`Currency.name` ● `String` scalar

Localised display name (e.g. Euro, US Dollar).

`Currency.position` ● `Int` scalar

1 renders the symbol *after* the amount, 0 renders it *before*.

`Currency.isDefaultCurrency` ● `Boolean!` non-null scalar

True for the shop's system default currency. Derived from Defaults::CURRENCY; equivalent to id === Defaults::CURRENCY but cheaper for clients than fetching the default id separately.