currentBulkOperation
query

Choose a version:

Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.

Anchor to section titled 'Arguments'

Arguments

Anchor to type type BulkOperationType default:QUERY: The current bulk operation's type.

Was this section helpful?

Anchor to section titled 'BulkOperation possible returns'

BulkOperation possible returns

Anchor to BulkOperation BulkOperation BulkOperation: An asynchronous long-running operation to fetch data in bulk or to bulk import data.

Bulk operations are created using the bulkOperationRunQuery or bulkOperationRunMutation mutation. After they are created, clients should poll the status field for updates. When COMPLETED, the url field contains a link to the data in JSONL format.

Refer to the bulk operations guide for more details.

Was this section helpful?

Code examples for QUERY: currentBulkOperation

Query Reference for QUERY: currentBulkOperation

"{\n  currentBulkOperation {\n    # BulkOperation fields\n  }\n}"

Input Reference for QUERY: currentBulkOperation

Schema Reference for QUERY: currentBulkOperation

Display Examples for QUERY: currentBulkOperation

[
  {
    "example": {
      "type_name": "currentbulkoperation",
      "title": "Get the currentBulkOperation for a query",
      "description": "The following query retrieves the currentBulkOperation for a query.",
      "query_string": "query {\n  currentBulkOperation(type: QUERY) {\n    id\n    type\n    status\n  }\n}",
      "query_arguments": {
        "type": "QUERY"
      },
      "response": {
        "data": {
          "currentBulkOperation": {
            "id": "gid://shopify/BulkOperation/726270413",
            "type": "QUERY",
            "status": "CREATED"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/platform/bulk_operations/test/unit/graph_api/admin/bulk_operation_root_query_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { currentBulkOperation(type: QUERY) { id type status } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    currentBulkOperation(type: QUERY) {\n      id\n      type\n      status\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    currentBulkOperation(type: QUERY) {\n      id\n      type\n      status\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    currentBulkOperation(type: QUERY) {\n      id\n      type\n      status\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    currentBulkOperation(type: QUERY) {\n      id\n      type\n      status\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "type",
          "description": "The current bulk operation's type.",
          "type": {
            "kind": "ENUM",
            "name": "BulkOperationType",
            "list": false,
            "non_null": false
          },
          "defaultValue": "QUERY",
          "typeSignature": "BulkOperationType",
          "isDeprecated": false,
          "deprecationReason": null
        },
        "key": "type",
        "argValue": " \"QUERY\"",
        "typeKind": "QUERY"
      }
    ]
  }
]

currentBulkOperationquery

Arguments

BulkOperation possible returns

currentBulkOperation
query