Market
Manage a store's markets: their lifecycle, domain, pricing, tax, status, default language, and product assignment.
A market represents a set of countries a merchant sells to, with its own currency, pricing, domain and language configuration. Each country belongs to exactly one market, and the primary market is protected: it cannot be deleted and, except for its tax-inclusive setting, cannot be modified.
Provides endpoints to list and retrieve markets, create and update them, change domain, price, tax and status settings, set the default language, delete a market, and manage which products a market sells along with market-specific fixed prices.
List markets
Retrieve all markets of the store with their configuration.
Create market
Create a market with a name and covered countries.
Get market
Retrieve full detail of a single market, including domain, pricing, tax, language and status.
Update market
Update a market's name or covered countries.
Delete market
Permanently delete a market. The primary market cannot be deleted; deletion is irreversible.
Preview markets to be deleted
Given a set of countries, preview which existing markets would be fully claimed and therefore automatically deleted. Call this before creating or updating a market so the caller knows which markets will be removed.
Update market domain
Change a market's domain mode (primary domain or sub-path).
Update market price
Change a market's base currency, price adjustment and local-currency display. Custom exchange rate is not supported.
Update market tax
Change whether product prices include tax. This is the only update allowed on the primary market.
Update market status
Enable or pause a market. The primary market cannot be paused; pausing a market prevents customers from checking out.
Update market default language
Set the default language of a market. The language must already be published to the market and enabled.
List market languages
List the languages configured on a market, including each language's enabled and default status. Use this before setting the market's default language.
List market products
List the products of a market, this returns each product's on-sale status in this market and its price in the market's currency.
Add market products
Add products to a market so the market sells them.
Delete market products
Remove products from a market so the market stops selling them.
Update market product prices
Set or remove fixed prices of products in a market.