gateSubjectCreate - admin-graphql - MUTATION

Version: unstable

Description:

Creates a new Gate Subject.

Access Scopes

`write_gates` access scope. Also: You must have write access to `gates` and write access to the subject type to create gate subjects. For example, setting a gate on a `PRODUCT` requires the same access as mutating a `PRODUCT`.

Arguments

• input: GateSubjectCreateInput! - Specifies the input fields for a gate configuation.

Returns

• gateSubject: GateSubject The created gate subject.
• userErrors: GateSubjectUserError! The list of errors that occurred from executing the mutation.

Examples

• Create a gate subject and return the gate subject ID

          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\": \"mutation gateSubjectCreate($input: GateSubjectCreateInput!) { gateSubjectCreate(input: $input) { userErrors { field message } gateSubject { id configuration { id } active createdAt updatedAt } } }\",\n \"variables\": {\n    \"input\": {\n      \"gateConfigurationId\": \"gid://shopify/GateConfiguration/589189056\",\n      \"subject\": \"gid://shopify/Product/840541035\",\n      \"active\": false\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation gateSubjectCreate($input: GateSubjectCreateInput!) {\n      gateSubjectCreate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        gateSubject {\n          id\n          configuration {\n            id\n          }\n          active\n          createdAt\n          updatedAt\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"gateConfigurationId\": \"gid://shopify/GateConfiguration/589189056\",\n        \"subject\": \"gid://shopify/Product/840541035\",\n        \"active\": false\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  mutation gateSubjectCreate($input: GateSubjectCreateInput!) {\n    gateSubjectCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      gateSubject {\n        id\n        configuration {\n          id\n        }\n        active\n        createdAt\n        updatedAt\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"gateConfigurationId\": \"gid://shopify/GateConfiguration/589189056\",\n    \"subject\": \"gid://shopify/Product/840541035\",\n    \"active\": false\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << [\n    \"gateConfigurationId\" => \"gid://shopify/GateConfiguration/589189056\",\n    \"subject\" => \"gid://shopify/Product/840541035\",\n    \"active\" => false,\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation gateSubjectCreate($input: GateSubjectCreateInput!) {\n    gateSubjectCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      gateSubject {\n        id\n        configuration {\n          id\n        }\n        active\n        createdAt\n        updatedAt\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"gateConfigurationId\": \"gid://shopify/GateConfiguration/589189056\",\n        \"subject\": \"gid://shopify/Product/840541035\",\n        \"active\": false\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation gateSubjectCreate($input: GateSubjectCreateInput!) {\n  gateSubjectCreate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    gateSubject {\n      id\n      configuration {\n        id\n      }\n      active\n      createdAt\n      updatedAt\n    }\n  }\n}"
        

  input: {
    "input": {
      "gateConfigurationId": "gid://shopify/GateConfiguration/589189056",
      "subject": "gid://shopify/Product/840541035",
      "active": false
    }
  }

  response: {
    "data": {
      "gateSubjectCreate": {
        "userErrors": [],
        "gateSubject": {
          "id": "gid://shopify/GateSubject/974631523",
          "configuration": {
            "id": "gid://shopify/GateConfiguration/589189056"
          },
          "active": false,
          "createdAt": "2024-09-12T01:10:00Z",
          "updatedAt": "2024-09-12T01:10:00Z"
        }
      }
    }
  }