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.

Show arguments

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.

Show fields

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.

Show fields

Anchor to conditionsconditions

•MarketConditions

The conditions under which a visitor is in the market.

Show fields

Anchor to currencySettingscurrencySettings

•MarketCurrencySettings

The market’s currency settings.

Show fields

Anchor to deliverydelivery

•MarketDeliveryConfigurations!

non-null

The delivery settings for this market.

Show fields

Anchor to discountsdiscounts

•DiscountNodeConnection

The discounts that are available in this market.

Show fields

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 discountsCountdiscountsCount

•Count

The number of discounts that are assigned to this market.

Show fields

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.

Show fields

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.

Show fields

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 metafieldsByIdentifiersmetafieldsByIdentifiers

•[Metafield]!

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Show fields

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

Show input fields

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.

Show fields

Anchor to returnPolicyProfilereturnPolicyProfile

•ReturnPolicyProfile

The return policy profile for this market.

Show fields

Anchor to statusstatus

•MarketStatus!

non-null

Status of the market. Replaces the enabled field.

Show enum values

Anchor to typetype

•MarketType!

non-null

The type of the market.

Show enum values

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.

Show fields

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

Show fields

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.

Show enum values

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Show filters

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

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.

Show enum values

Anchor to priceListpriceList

•PriceList

Deprecated

Show fields

Anchor to primaryprimary

•Boolean!

non-nullDeprecated

Anchor to regionsregions

•MarketRegionConnection!

non-nullDeprecated

Show fields

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

Show fields

Was this section helpful?

Anchor to QueriesQueries

Anchor to market market

•query

Returns a Market resource by ID.

Show fields

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.

Show fields

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 enabledenabled

•Boolean

Default:null

Filters markets by enabled status.

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. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Show filters

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to market_condition_types •string: A comma-separated list of condition types.
Anchor to market_type •string
Anchor to name •string
Anchor to status •string
Anchor to wildcard_company_location_with_country_code •string

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.

Show enum values

Anchor to typetype

•MarketType

Default:null

Filters markets by type.

Show enum values

Deprecated queries

Anchor to marketByGeography marketByGeography

•query

Deprecated

Show fields

Arguments

Anchor to countryCodecountryCode

•CountryCode!

required

The code for the country where the customer is.

Show enum values

Anchor to primaryMarket primaryMarket

•query

Deprecated

Show fields

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.

Show payload