Choose a version:

Market

object

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

A merchant-defined group of buyers identified by conditions such as their region, retail location, or company location. Each market allows configuration of a distinct, localized buyer experience. Customizations include, but are not limited to, currency, pricing and product availability, web presence, and content translations.

Anchor to FieldsFields

Anchor to assignedCustomizationassignedCustomization

•Boolean!

non-null

Whether the market has a customization with the given ID.

Anchor to customizationIdcustomizationId •ID! required: The ID of the customization that the market has been assigned to.

Anchor to catalogscatalogs

•MarketCatalogConnection!

non-null

The catalogs that belong to the market.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to catalogsCountcatalogsCount

•Count

The number of catalogs that belong to the market.

Anchor to conditionsconditions

•MarketConditions

The conditions under which a visitor is in the market.

Anchor to currencySettingscurrencySettings

•MarketCurrencySettings

The market’s currency settings.

Anchor to handlehandle

•String!

non-null

A short, human-readable unique identifier for the market. This is changeable by the merchant.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to namename

•String!

non-null

The name of the market. Not shown to customers.

Anchor to priceInclusionspriceInclusions

•MarketPriceInclusions

The inclusive pricing strategy for a market. This determines if prices include duties and / or taxes.

Anchor to statusstatus

•MarketStatus!

non-null

Status of the market. Replaces the enabled field.

Anchor to typetype

•MarketType!

non-null

The type of the market.

Anchor to webPresenceswebPresences

•MarketWebPresenceConnection!

non-null

The market’s web presences, which defines its SEO strategy. This can be a different domain, subdomain, or subfolders of the primary domain. Each web presence comprises one or more language variants. If a market doesn't have any web presences, then the market is accessible on the primary market's domains using country selectors.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Deprecated fields

Anchor to enabledenabled

•Boolean!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to priceListpriceList

•PriceList

Deprecated

Anchor to primaryprimary

•Boolean!

non-nullDeprecated

Anchor to regionsregions

•MarketRegionConnection!

non-nullDeprecated

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to webPresencewebPresence

•MarketWebPresence

Deprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to market market

•query

Returns a Market resource by ID.

Anchor to idid •ID! required: The ID of the Market to return.

Anchor to markets markets

•query

Returns a paginated list of Market objects configured for the shop. Markets match buyers based on defined conditions to deliver customized shopping experiences.

Filter markets by MarketType and MarketStatus, search by name, and control sort order. Retrieve market configurations including MarketCurrencySettings, MarketWebPresence objects, and MarketConditions.

Learn more about Shopify Markets.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
market_condition_types	string	A comma-separated list of condition types.
market_type	string
name	string
status	string		- `ACTIVE` - `DRAFT`
wildcard_company_location_with_country_code	string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MarketsSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to typetype

•MarketType

Default:null

Filters markets by type.

Deprecated queries

Anchor to marketByGeography marketByGeography

•query

Deprecated

Arguments

Anchor to countryCodecountryCode

•CountryCode!

required

The code for the country where the customer is.

Anchor to primaryMarket primaryMarket

•query

Deprecated

Was this section helpful?

Anchor to MutationsMutations

Anchor to marketCreate marketCreate

•mutation

Creates a Market to deliver customized shopping experiences. Markets define various aspects of the buyer experience including pricing, product availability, custom content, inventory and fulfillment priorities, and payment methods.

Define conditions to match buyers by region, company location, retail location, or other criteria. Configure MarketCurrencySettings to control currency behavior. Set MarketPriceInclusions to determine tax and duty display. Assign Catalog objects and MarketWebPresence configurations to control product availability and SEO strategy.

Learn more about Shopify Markets.