gateConfiguration

queryDeprecated

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

Fetch a gate configuration resource by ID. Gates API is being sunset and will be removed in a future version. Use metafields instead for gate configuration.

Arguments

Anchor to idid • ID!required: The ID of the gate configuration to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to GateConfigurationGateConfiguration • GateConfiguration: Represents a gate configuration, which stores the information about a gate. A gate configuration can be bound to multiple subjects via the GateSubject model.

Was this section helpful?

Get a gate configuration by ID
Get all gate configurations fields and connections
Get gateSubjects for a gate configuration

Examples

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

const response = await admin.graphql(

`#graphql

query gateConfiguration($id: ID!) {

gateConfiguration(id: $id) {

}

}`,

{

variables: {

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

);

const data = await response.json();

query gateConfiguration($id: ID!) {
  gateConfiguration(id: $id) {
    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 gateConfiguration($id: ID!) { gateConfiguration(id: $id) { id } }",
 "variables": {
    "id": "gid://shopify/GateConfiguration/43548663"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query gateConfiguration($id: ID!) {
    gateConfiguration(id: $id) {
      id
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/GateConfiguration/43548663"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query gateConfiguration($id: ID!) {
      gateConfiguration(id: $id) {
        id
      }
    }`,
    "variables": {
      "id": "gid://shopify/GateConfiguration/43548663"
    },
  },
});

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 gateConfiguration($id: ID!) {
    gateConfiguration(id: $id) {
      id
    }
  }
QUERY

variables = {
  "id": "gid://shopify/GateConfiguration/43548663"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

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

}

Response

JSON

{

"gateConfiguration": {

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

}