Skip to main content

MarketUpdateInput

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

Input for updating a market. Only the fields you send change; send null to clear an optional field. The code and the currency can never change.

input MarketUpdateInput {
descriptions: [LocalizedStringInput!]
defaultTaxZone: String
cashRounding: CashRounding
names: [LocalizedStringInput!]
isDefault: Boolean
}

Fields​

MarketUpdateInput.descriptions ● [LocalizedStringInput!] list input​

Description of the market per language.

Validation: each language at most once.

MarketUpdateInput.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.

MarketUpdateInput.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.

MarketUpdateInput.names ● [LocalizedStringInput!] list input​

Name of the market per language. Replaces all names. Omit to leave them unchanged.

Validation: at least one entry, each language at most once; cannot be null.

MarketUpdateInput.isDefault ● Boolean scalar​

Set to true to make this market the tenant's default market. The previous default stops being the default. The default can only be moved, never turned off: false is refused.

Member Of​

marketUpdate mutation