Choose a version:

job

query

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

Anchor to Arguments

Arguments

Anchor to idid •ID! required: ID of the job to query.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to JobJob

•Job

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

Anchor to donedone •Boolean! non-null: This indicates if the job is still queued or has been run.
Anchor to idid •ID! non-null: A globally-unique ID that's returned when running an asynchronous mutation.
Anchor to queryquery •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.

Was this section helpful?

Examples

Get the status of a queued collectionUpdate job

Description

The following query retrieves the status of a queued collectionUpdate job.

Query

query {
  job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
    id
    done
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { job(id: \"gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8\") { id done } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }`,
});

Response

{
  "job": {
    "id": "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8",
    "done": false
  }
}

Get the status of a queued collectionUpdate job

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query {

job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {

done

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
    id
    done
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { job(id: \"gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8\") { id done } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }`,
});

Ruby

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 {
    job(id: "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8") {
      id
      done
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"job": {

"id": "gid://shopify/Job/dc9b2604-c73b-45c6-8942-e235bac987e8",

"done": false

}