Skip to main content

MarketCreateInput

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

Input for creating a market: a name with one currency. The tenant's first market becomes its default market; to move the default later, update a market with isDefault: true.

input MarketCreateInput {
code: String!
names: [LocalizedStringInput!]!
descriptions: [LocalizedStringInput!]
currency: String!
defaultTaxZone: String
cashRounding: CashRounding
}

Fields​

MarketCreateInput.code ● String! non-null scalar​

Code of the market, unique within the tenant, e.g. CH-CHF. Imports refer to markets by this code. Can never change.

Validation: 1 to 64 characters of free text. The code is stored exactly as sent and is case-sensitive, so 'ch-chf' and 'CH-CHF' are two different codes.

MarketCreateInput.names ● [LocalizedStringInput!]! non-null input​

Name of the market per language.

Validation: at least one entry, each language at most once.

MarketCreateInput.descriptions ● [LocalizedStringInput!] list input​

Description of the market per language.

Validation: each language at most once.

MarketCreateInput.currency ● String! non-null scalar​

Currency of the market as an ISO 4217 code, e.g. EUR. Several markets can share a currency. Can never change.

Validation: a valid ISO 4217 currency code; stored in uppercase.

MarketCreateInput.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, as today.

Validation: exactly 2 characters, the same rule as pricing's tax zone. Stored exactly as sent.

MarketCreateInput.cashRounding ● CashRounding enum​

Cash rounding step for the order total, e.g. STEP_0_05. Only the order total is rounded. Empty means no rounding, as today.

Member Of​

marketCreate mutation