job - admin-graphql - QUERY

Version: 2024-10

Description:

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

Access Scopes

Arguments

• id: ID! - ID of the job to query.

Returns

• done: Boolean! This indicates if the job is still queued or has been run.
• id: ID! A globally-unique ID that's returned when running an asynchronous mutation.
• query: QueryRoot This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job.

Examples

• Get the status of a queued collectionUpdate job

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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"
          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"
          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"
          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 {\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"
          Graphql query: "query {\n  job(id: \"gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1\") {\n    id\n    done\n  }\n}"
        

  input: null

  response: {
    "data": {
      "job": {
        "id": "gid://shopify/Job/0dc20457-a372-4c18-ad5d-67d0e29590a1",
        "done": false
      }
    }
  }