markets_write
Arguments
ID
The id of the market to update. Omit to create one.
required
The market’s settings.
Show fields
Show fields
Destination countries to add. Required when creating. A country can belong to only one market; adding one this market already has does nothing. Each new country is set up as a market, catalog and price list on the store’s sales channel. If a country is already in one of the merchant’s own Shopify markets, the request fails with MARKET_COUNTRY_CONFLICT until
resolutions says what to do with it.How uncharged landed-cost lines appear in the checkout breakdown. Defaults to REMOVE.
Landed-cost components whose checkout charge the markup absorbs, in order. Must not overlap
includedInPrice.Boolean
Whether the market’s pricing is live. Defaults to false.
Landed-cost components neither charged nor shown at checkout. Must not overlap
includedInPrice.Landed-cost components to bake into product prices. FEES is only allowed with ADAPTIVE_COEFFICIENT, which requires either TAXES alone or all three.
The markup on the base price, as a fraction from “0” to “1” with at most 6 decimal places (e.g. “0.1” for 10%). Defaults to 0.
How the markup combines with the landed cost. Defaults to ABSORBING.
String
The market’s name. Send null or an empty string to clear.
How landed costs are turned into prices. Defaults to COEFFICIENT, or CALCULATED when
includedInPrice is set.Destination countries to remove. Not allowed when creating, and each must currently be in the market. Removing a country tears down its Shopify market, catalog and price list, so shoppers there stop seeing this market’s prices. The market must keep at least one country.
Resolutions for countries in
addCountryCodes that are already in one of the merchant’s own Shopify markets, as reported in a MARKET_COUNTRY_CONFLICT error: each conflict’s reason explains it, and each of its allowedResolutions gives a kind to send here with an effect describing the outcome. TAKE_OVER adopts that Shopify market; ARCHIVE_EXISTING sets it to draft; REMOVE_REGION removes the country from it. Naming a country without such a conflict fails with UNEXPECTED_MARKET_RESOLUTION.Show fields
Show fields
required
A country in
addCountryCodes.The resolution. Must be a
kind from the conflict’s allowedResolutions; its effect says what happens to the merchant’s Shopify market.Returns
A cross-border market: a set of destination countries that share one landed-cost pricing policy.
Show fields
Show fields
required
How uncharged landed-cost lines appear in the checkout breakdown.
required
required
The destination countries this market sells into.
required
Landed-cost components whose checkout charge is absorbed by the markup, drawn down in order.
Boolean!
required
Whether the market’s pricing is live.
required
Landed-cost components neither charged nor shown at checkout.
ID!
required
The id of this market.
required
Landed-cost components baked into product prices.
required
How the markup combines with the landed cost in the price.
String
The merchant-set name. Null when unnamed; the countries then identify the market.
required
How landed costs are turned into prices.
String!
required
The ISO 4217 currency of the store’s base prices, which the market’s prices are converted from.
Example
mutation {
upsertMarket(id: "...", input: { ... }) {
breakdownDisplay
coveredByMarkup
createdAt
enabled
excludedFromCheckout
id
includedInPrice
lastSyncedAt
# ...
}
}