gateConfigurations - admin-graphql - QUERY

Version: unstable

Description:

List of the shop's gate configurations.

Access Scopes

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

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | app_id | id | | created_at | time | | handle | string | | id | id | Filter by `id` range. | | | - `id:1234`
  - `id:>=1234`
  - `id:<=1234` | | name | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
• reverse: Boolean - Reverse the order of the underlying list.
• sortKey: GateConfigurationsSortKeys - 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).

Returns

• edges: GateConfigurationEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: GateConfiguration! 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.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Get all gate configurations for a store

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query gateConfigurations { gateConfigurations(first: 10) { nodes { id } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query gateConfigurations {\n    gateConfigurations(first: 10) {\n      nodes {\n        id\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query gateConfigurations {\n    gateConfigurations(first: 10) {\n      nodes {\n        id\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query gateConfigurations {\n    gateConfigurations(first: 10) {\n      nodes {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query gateConfigurations {\n  gateConfigurations(first: 10) {\n    nodes {\n      id\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "gateConfigurations": {
        "nodes": [
          {
            "id": "gid://shopify/GateConfiguration/43548663"
          }
        ]
      }
    }
  }

  Get all gate_configurations in order of last edited

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query gateConfigurations { gateConfigurations(first: 10, sortKey: UPDATED_AT, reverse: true) { nodes { id } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query gateConfigurations {\n    gateConfigurations(first: 10, sortKey: UPDATED_AT, reverse: true) {\n      nodes {\n        id\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query gateConfigurations {\n    gateConfigurations(first: 10, sortKey: UPDATED_AT, reverse: true) {\n      nodes {\n        id\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query gateConfigurations {\n    gateConfigurations(first: 10, sortKey: UPDATED_AT, reverse: true) {\n      nodes {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query gateConfigurations {\n  gateConfigurations(first: 10, sortKey: UPDATED_AT, reverse: true) {\n    nodes {\n      id\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "gateConfigurations": {
        "nodes": [
          {
            "id": "gid://shopify/GateConfiguration/589189052"
          },
          {
            "id": "gid://shopify/GateConfiguration/43548663"
          }
        ]
      }
    }
  }

  Get gate configurations by name

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query gateConfigurations { gateConfigurations(first: 10, query: \\\"name:'\\''test gate'\\''\\\") { nodes { id } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query gateConfigurations {\n    gateConfigurations(first: 10, query: \"name:'test gate'\") {\n      nodes {\n        id\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query gateConfigurations {\n    gateConfigurations(first: 10, query: \"name:'test gate'\") {\n      nodes {\n        id\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query gateConfigurations {\n    gateConfigurations(first: 10, query: \"name:'test gate'\") {\n      nodes {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query gateConfigurations {\n  gateConfigurations(first: 10, query: \"name:'test gate'\") {\n    nodes {\n      id\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "gateConfigurations": {
        "nodes": [
          {
            "id": "gid://shopify/GateConfiguration/589189053"
          }
        ]
      }
    }
  }