ProductOperation - admin-graphql - INTERFACE

Version: 2024-10

Description:

An entity that represents details of an asynchronous operation on a product.

Access Scopes

`read_products` access scope.

Fields

• product: Product - The product on which the operation is being performed.
• status: ProductOperationStatus! - The status of this operation.

Connections

Types implemented in

• ProductBundleOperation
• ProductDeleteOperation
• ProductDuplicateOperation
• ProductSetOperation

Examples

• View the status of an asynchronous product delete operation

          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 ProductDeleteOperation($id: ID!) { productOperation(id: $id) { ... on ProductDeleteOperation { id status deletedProductId product { id } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ProductDeleteOperation/843567278\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ProductDeleteOperation($id: ID!) {\n      productOperation(id: $id) {\n        ... on ProductDeleteOperation {\n          id\n          status\n          deletedProductId\n          product {\n            id\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ProductDeleteOperation/843567278\"\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 ProductDeleteOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductDeleteOperation {\n        id\n        status\n        deletedProductId\n        product {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ProductDeleteOperation/843567278\"\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 = <<<QUERY\n  query ProductDeleteOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductDeleteOperation {\n        id\n        status\n        deletedProductId\n        product {\n          id\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ProductDeleteOperation/843567278\",\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  query ProductDeleteOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductDeleteOperation {\n        id\n        status\n        deletedProductId\n        product {\n          id\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ProductDeleteOperation/843567278\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ProductDeleteOperation($id: ID!) {\n  productOperation(id: $id) {\n    ... on ProductDeleteOperation {\n      id\n      status\n      deletedProductId\n      product {\n        id\n      }\n    }\n  }\n}"
        

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

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

  View the status of an asynchronous product duplicate operation

          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 ProductDuplicateOperation($operationId: ID!) { productOperation(id: $operationId) { ... on ProductDuplicateOperation { id status newProduct { id title } userErrors { field message } } } }\",\n \"variables\": {\n    \"operationId\": \"gid://shopify/ProductDuplicateOperation/893212316\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ProductDuplicateOperation($operationId: ID!) {\n      productOperation(id: $operationId) {\n        ... on ProductDuplicateOperation {\n          id\n          status\n          newProduct {\n            id\n            title\n          }\n          userErrors {\n            field\n            message\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"operationId\": \"gid://shopify/ProductDuplicateOperation/893212316\"\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 ProductDuplicateOperation($operationId: ID!) {\n    productOperation(id: $operationId) {\n      ... on ProductDuplicateOperation {\n        id\n        status\n        newProduct {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"operationId\": \"gid://shopify/ProductDuplicateOperation/893212316\"\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 = <<<QUERY\n  query ProductDuplicateOperation($operationId: ID!) {\n    productOperation(id: $operationId) {\n      ... on ProductDuplicateOperation {\n        id\n        status\n        newProduct {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"operationId\" => \"gid://shopify/ProductDuplicateOperation/893212316\",\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  query ProductDuplicateOperation($operationId: ID!) {\n    productOperation(id: $operationId) {\n      ... on ProductDuplicateOperation {\n        id\n        status\n        newProduct {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"operationId\": \"gid://shopify/ProductDuplicateOperation/893212316\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ProductDuplicateOperation($operationId: ID!) {\n  productOperation(id: $operationId) {\n    ... on ProductDuplicateOperation {\n      id\n      status\n      newProduct {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "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

          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 productSetOperation($id: ID!) { productOperation(id: $id) { ... on ProductSetOperation { id status product { id } userErrors { field message code } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ProductSetOperation/824846712\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query productSetOperation($id: ID!) {\n      productOperation(id: $id) {\n        ... on ProductSetOperation {\n          id\n          status\n          product {\n            id\n          }\n          userErrors {\n            field\n            message\n            code\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ProductSetOperation/824846712\"\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 productSetOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductSetOperation {\n        id\n        status\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ProductSetOperation/824846712\"\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 = <<<QUERY\n  query productSetOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductSetOperation {\n        id\n        status\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ProductSetOperation/824846712\",\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  query productSetOperation($id: ID!) {\n    productOperation(id: $id) {\n      ... on ProductSetOperation {\n        id\n        status\n        product {\n          id\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ProductSetOperation/824846712\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query productSetOperation($id: ID!) {\n  productOperation(id: $id) {\n    ... on ProductSetOperation {\n      id\n      status\n      product {\n        id\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\n}"
        

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

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