markets

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

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the markets action (under Markets).
Fill in the fields below, then reference the result from later steps as {{markets.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Markets($type: MarketType, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: MarketsSortKeys, $query: String) {
  markets(
    type: $type
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        catalogsCount
        conditions
        currencySettings
        delivery
        discountsCount
        enabled
        handle
        id
        name
        priceInclusions
        priceList
        primary
        status
        type
        webPresence
      }
    }
    nodes {
      catalogsCount {
        count
        precision
      }
      conditions {
        channelsCondition
        companyLocationsCondition
        conditionTypes
        locationsCondition
        regionsCondition
      }
      currencySettings {
        baseCurrency
        localCurrencies
        roundingEnabled
      }
      delivery {
        shipping
      }
      discountsCount {
        count
        precision
      }
      enabled
      handle
      id
      name
      priceInclusions {
        adaptivePricingEnabled
        inclusiveDutiesPricingStrategy
        inclusiveTaxPricingStrategy
      }
      priceList {
        catalog
        currency
        fixedPricesCount
        id
        name
        parent
      }
      primary
      status
      type
      webPresence {
        alternateLocales
        defaultLocale
        domain
        id
        market
        rootUrls
        subfolderSuffix
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

typestring

Filters markets by type.

One ofNONEREGIONLOCATIONCOMPANY_LOCATIONCHANNEL

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATIDMARKET_CONDITION_TYPESMARKET_TYPENAMESTATUSUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | market_condition_types | string | A comma-separated list of condition types. | | market_type | string | | name | string | | status | string | | - `ACTIVE`<br/> - `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).

json

{
  "type": "NONE",
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string"
}

Response

Read the result with {{markets.response.data.data.markets}}. If the API returns errors, the step fails and they are at {{markets.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

catalogsCountobject

conditionsobject

currencySettingsobject

deliveryobject

discountsCountobject

enabledobject

handleobject

idobject

nameobject

priceInclusionsobject

priceListobject

primaryobject

statusobject

typeobject

webPresenceobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?