Skip to main content

Market

BETA: markets can still change in ways that break existing integrations. Backwards compatibility is not guaranteed while it is in beta.

A market: a name with one currency. Prices and other fixed amounts belong to a market. Exactly one market of a tenant is its default market.

type Market {
id: String!
code: String!
names: [LocalizedString!]!
descriptions: [LocalizedString!]
currency: String!
isDefault: Boolean!
defaultTaxZone: String
cashRounding: CashRounding
createdAt: DateTime!
lastModifiedAt: DateTime!
channels: [Channel!]!
}

Fields​

Market.id ● String! non-null scalar​

Unique identifier of the market (a UUID).

Market.code ● String! non-null scalar​

Code of the market, unique within the tenant, exactly as it was created, e.g. CH-CHF. Case-sensitive. Can never change.

Market.names ● [LocalizedString!]! non-null object​

Name of the market per language.

Market.descriptions ● [LocalizedString!] list object​

Description of the market per language.

Market.currency ● String! non-null scalar​

Currency of the market as an ISO 4217 code, e.g. EUR. Can never change.

Market.isDefault ● Boolean! non-null scalar​

Whether this is the tenant's default market. Exactly one market of a tenant is the default. It is used where there is no channel to pick a market from.

Market.defaultTaxZone ● String scalar​

Tax zone used for calls in this market that have no tax zone and no delivery country, e.g. US. Empty means NL.

Market.cashRounding ● CashRounding enum​

Cash rounding step for the order total, e.g. STEP_0_05. Empty means no rounding.

Market.createdAt ● DateTime! non-null scalar​

Timestamp when the market was created.

Market.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the market was last modified.

Market.channels ● [Channel!]! non-null object​

The channels that sell this market, by id.

Returned By​

market query ● marketCreate mutation ● markets query ● marketUpdate mutation

Member Of​

Channel object