job
query

Choose a version:

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: ID of the job to query.

Was this section helpful?

Anchor to section titled 'Job possible returns'

Job possible returns

Anchor to Job Job Job: A job corresponds to some long running task that the client should poll for status.

Was this section helpful?

Code examples for QUERY: job

Query Reference for QUERY: job

"{\n  job(id) {\n    # Job fields\n  }\n}"

Input Reference for QUERY: job

Schema Reference for QUERY: job

Display Examples for QUERY: job

[
  {
    "example": {
      "type_name": "job",
      "title": "Get the status of a queued collectionUpdate job",
      "description": "The following query retrieves the status of a queued collectionUpdate job.",
      "query_string": "query {\n  job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n    id\n    done\n  }\n}",
      "query_arguments": {
        "id": "gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1"
      },
      "response": {
        "data": {
          "job": {
            "id": "gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1",
            "done": false
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/platform/admin/test/unit/graph_api/admin/query_root_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { job(id: \\\"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\\\") { id done } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n      id\n      done\n    }\n  }`,\n);\n\nconst data = await response.json();\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 {\n    job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n      id\n      done\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n      id\n      done\n    }\n  }`,\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n      id\n      done\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "ID of the job to query.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null
        },
        "key": "id",
        "argValue": " \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\"",
        "typeKind": "QUERY"
      }
    ]
  }
]

jobquery

Arguments

Job possible returns

job
query