Choose a version:

productOperation

query

Returns a ProductOperation resource by ID.

This can be used to query the ProductSetOperation, using the ID that was returned when the product was created or updated by the ProductSet mutation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the created or updated product.

For the ProductSetOperation, the userErrors field provides mutation errors that occurred during the operation.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ProductOperationProductOperation

•ProductOperation

An interface representing asynchronous operations on products. Tracks the status and details of background product mutations like productSet, productDelete, productDuplicate, and productBundle operations. Provides status field (CREATED, ACTIVE, COMPLETE) and product field to monitor long-running product operations.

Anchor to productproduct

•Product

The product on which the operation is being performed.

Anchor to statusstatus

•ProductOperationStatus!

non-null

The status of this operation.

Was this section helpful?

Examples

View the status of an asynchronous product delete operation

Query

query ProductDeleteOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductDeleteOperation {
      id
      status
      deletedProductId
      product {
        id
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/ProductDeleteOperation/843567278"
}

cURL

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 ProductDeleteOperation($id: ID!) { productOperation(id: $id) { ... on ProductDeleteOperation { id status deletedProductId product { id } } } }",
 "variables": {
    "id": "gid://shopify/ProductDeleteOperation/843567278"
  }
}'

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 ProductDeleteOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductDeleteOperation {
        id
        status
        deletedProductId
        product {
          id
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/ProductDeleteOperation/843567278"
    },
  },
  );
  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 ProductDeleteOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductDeleteOperation {
        id
        status
        deletedProductId
        product {
          id
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ProductDeleteOperation/843567278"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ProductDeleteOperation($id: ID!) {
      productOperation(id: $id) {
        ... on ProductDeleteOperation {
          id
          status
          deletedProductId
          product {
            id
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/ProductDeleteOperation/843567278"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query ProductDeleteOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductDeleteOperation {
      id
      status
      deletedProductId
      product {
        id
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/ProductDeleteOperation/843567278"
}'

Response

{
  "productOperation": {
    "id": "gid://shopify/ProductDeleteOperation/843567278",
    "status": "COMPLETE",
    "deletedProductId": "gid://shopify/Product/20995642",
    "product": null
  }
}

View the status of an asynchronous product duplicate operation

Query

query ProductDuplicateOperation($operationId: ID!) {
  productOperation(id: $operationId) {
    ... on ProductDuplicateOperation {
      id
      status
      newProduct {
        id
        title
      }
      userErrors {
        field
        message
      }
    }
  }
}

Variables

{
  "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
}

cURL

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 ProductDuplicateOperation($operationId: ID!) { productOperation(id: $operationId) { ... on ProductDuplicateOperation { id status newProduct { id title } userErrors { field message } } } }",
 "variables": {
    "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
  }
}'

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 ProductDuplicateOperation($operationId: ID!) {
    productOperation(id: $operationId) {
      ... on ProductDuplicateOperation {
        id
        status
        newProduct {
          id
          title
        }
        userErrors {
          field
          message
        }
      }
    }
  }`,
  {
    variables: {
        "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
    },
  },
  );
  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 ProductDuplicateOperation($operationId: ID!) {
    productOperation(id: $operationId) {
      ... on ProductDuplicateOperation {
        id
        status
        newProduct {
          id
          title
        }
        userErrors {
          field
          message
        }
      }
    }
  }
QUERY

variables = {
  "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ProductDuplicateOperation($operationId: ID!) {
      productOperation(id: $operationId) {
        ... on ProductDuplicateOperation {
          id
          status
          newProduct {
            id
            title
          }
          userErrors {
            field
            message
          }
        }
      }
    }`,
    "variables": {
        "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query ProductDuplicateOperation($operationId: ID!) {
  productOperation(id: $operationId) {
    ... on ProductDuplicateOperation {
      id
      status
      newProduct {
        id
        title
      }
      userErrors {
        field
        message
      }
    }
  }
}' \
--variables \
'{
  "operationId": "gid://shopify/ProductDuplicateOperation/893212316"
}'

Response

{
  "productOperation": {
    "id": "gid://shopify/ProductDuplicateOperation/893212316",
    "status": "COMPLETE",
    "newProduct": {
      "id": "gid://shopify/Product/108828309",
      "title": "Draft (Copy)"
    },
    "userErrors": []
  }
}

View the status of an asynchronous product set operation

Query

query productSetOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductSetOperation {
      id
      status
      product {
        id
      }
      userErrors {
        field
        message
        code
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/ProductSetOperation/824846712"
}

cURL

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 productSetOperation($id: ID!) { productOperation(id: $id) { ... on ProductSetOperation { id status product { id } userErrors { field message code } } } }",
 "variables": {
    "id": "gid://shopify/ProductSetOperation/824846712"
  }
}'

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 productSetOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductSetOperation {
        id
        status
        product {
          id
        }
        userErrors {
          field
          message
          code
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/ProductSetOperation/824846712"
    },
  },
  );
  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 productSetOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductSetOperation {
        id
        status
        product {
          id
        }
        userErrors {
          field
          message
          code
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ProductSetOperation/824846712"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query productSetOperation($id: ID!) {
      productOperation(id: $id) {
        ... on ProductSetOperation {
          id
          status
          product {
            id
          }
          userErrors {
            field
            message
            code
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/ProductSetOperation/824846712"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query productSetOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductSetOperation {
      id
      status
      product {
        id
      }
      userErrors {
        field
        message
        code
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/ProductSetOperation/824846712"
}'

Response

{
  "productOperation": {
    "id": "gid://shopify/ProductSetOperation/824846712",
    "status": "COMPLETE",
    "product": {
      "id": "gid://shopify/Product/20995642"
    },
    "userErrors": []
  }
}

Examples

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

productOperation(id: $id) {

... on ProductDeleteOperation {

status

deletedProductId

product {

}

}`,

{

variables: {

"id": "gid://shopify/ProductDeleteOperation/843567278"

);

const json = await response.json();

return json.data;

}

GQL

query ProductDeleteOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductDeleteOperation {
      id
      status
      deletedProductId
      product {
        id
      }
    }
  }
}

cURL

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 ProductDeleteOperation($id: ID!) { productOperation(id: $id) { ... on ProductDeleteOperation { id status deletedProductId product { id } } } }",
 "variables": {
    "id": "gid://shopify/ProductDeleteOperation/843567278"
  }
}'

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 ProductDeleteOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductDeleteOperation {
        id
        status
        deletedProductId
        product {
          id
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/ProductDeleteOperation/843567278"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ProductDeleteOperation($id: ID!) {
      productOperation(id: $id) {
        ... on ProductDeleteOperation {
          id
          status
          deletedProductId
          product {
            id
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/ProductDeleteOperation/843567278"
    },
  },
});

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 ProductDeleteOperation($id: ID!) {
    productOperation(id: $id) {
      ... on ProductDeleteOperation {
        id
        status
        deletedProductId
        product {
          id
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/ProductDeleteOperation/843567278"
}

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

Shopify CLI

shopify app execute \
--query \
'query ProductDeleteOperation($id: ID!) {
  productOperation(id: $id) {
    ... on ProductDeleteOperation {
      id
      status
      deletedProductId
      product {
        id
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/ProductDeleteOperation/843567278"
}'

Input variables

JSON

{

"id": "gid://shopify/ProductDeleteOperation/843567278"

}

Response

JSON

{

"productOperation": {

"id": "gid://shopify/ProductDeleteOperation/843567278",

"status": "COMPLETE",

"deletedProductId": "gid://shopify/Product/20995642",

"product": null

}