Skip to main content

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!
isDefaultCurrency: Boolean!
isoCode: String!
name: String
position: Int
shortName: String
symbol: String!
orders(
first: Int = 10
after: String
filter: OrderFilterInput
): OrderConnection
salesChannelDefaultAssignments(
first: Int = 10
after: String
filter: SalesChannelFilterInput
): SalesChannelConnection
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.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.

Currency.isoCode ● String! non-null scalar​

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

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.shortName ● String scalar​

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

Currency.symbol ● String! non-null scalar​

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

Currency.orders ● OrderConnection object​

Currency.orders.first ● Int scalar​
Currency.orders.after ● String scalar​
Currency.orders.filter ● OrderFilterInput input​

Currency.salesChannelDefaultAssignments ● SalesChannelConnection object​

Currency.salesChannelDefaultAssignments.first ● Int scalar​
Currency.salesChannelDefaultAssignments.after ● String scalar​
Currency.salesChannelDefaultAssignments.filter ● SalesChannelFilterInput input​

Currency.salesChannels ● SalesChannelConnection object​

Currency.salesChannels.first ● Int scalar​
Currency.salesChannels.after ● String scalar​
Currency.salesChannels.filter ● SalesChannelFilterInput input​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

currency query

Member Of​

CurrencyEdge object ● GoodsReceipt object ● Order object ● Quote object ● SalesChannel object ● Supplier object ● SupplierOrder object