gateConfigurations

queryDeprecated

Requires read_gates access scope. Also: You must have read access to gates to read gate configurations.

List of the shop's gate configurations. Gates API is being sunset and will be removed in a future version. Use metafields instead for gate configuration.

GateConfigurationConnection arguments

•GateConfigurationConnection

after

•

String

The elements that come after the specified cursor.

before

•

String

The elements that come before the specified cursor.

first

•

Int

The first n elements from the paginated list.

last

•

Int

The last n elements from the paginated list.

query

•

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 app_id • id
Anchor to created_at • time
Anchor to handle • string
Anchor to id • id: Filter by id range.
Anchor to name • string
Anchor to updated_at • time

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [GateConfigurationEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [GateConfiguration!]!non-null: A list of nodes that are contained in GateConfigurationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Get all gate configurations for a store
Get all gate_configurations in order of last edited
Get gate configurations by name

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query gateConfigurations {

gateConfigurations(first: 10) {

nodes {

}

}`,

);

const data = await response.json();

query gateConfigurations {
  gateConfigurations(first: 10) {
    nodes {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query gateConfigurations { gateConfigurations(first: 10) { nodes { id } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query gateConfigurations {
    gateConfigurations(first: 10) {
      nodes {
        id
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query gateConfigurations {
    gateConfigurations(first: 10) {
      nodes {
        id
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query gateConfigurations {
    gateConfigurations(first: 10) {
      nodes {
        id
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"gateConfigurations": {

"nodes": [

{

"id": "gid://shopify/GateConfiguration/43548663"

}

]

}