Skip to main content
Anchor to marketByGeography

marketByGeography

query

Requires The user must have markets API access.

Deprecated. This market_by_geography field will be removed in a future version of the API.

Returns the applicable market for a customer based on where they are in the world.

Anchor to Arguments

Arguments

Anchor to countryCodecountryCode
•CountryCode!
required

The code for the country where the customer is.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to MarketMarket
•Market

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 assignedCustomizationassignedCustomization
•Boolean!
non-null

Whether the market has a customization with the given ID.

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.

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

Arguments

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.

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

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 reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

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

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
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

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 reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to webPresencewebPresence
•MarketWebPresence
Deprecated
Was this section helpful?