BulkOperation

object

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.

Anchor to FieldsFields

Anchor to completedAtcompletedAt • DateTime: When the bulk operation was successfully completed.
Anchor to createdAtcreatedAt • DateTime!non-null: When the bulk operation was created.
Anchor to errorCodeerrorCode • BulkOperationErrorCode: Error code for failed operations.
Anchor to fileSizefileSize • UnsignedInt64: File size in bytes of the file in the url field.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to objectCountobjectCount • UnsignedInt64!non-null: A running count of all the objects processed. For example, when fetching all the products and their variants, this field counts both products and variants. This field can be used to track operation progress.
Anchor to partialDataUrlpartialDataUrl • URL: The URL that points to the partial or incomplete response data (in JSONL format) that was returned by a failed operation. The URL expires 7 days after the operation fails. Returns null when there's no data available.
Anchor to queryquery • String!non-null: GraphQL query document specified in bulkOperationRunQuery.
Anchor to rootObjectCountrootObjectCount • UnsignedInt64!non-null: A running count of all the objects that are processed at the root of the query. For example, when fetching all the products and their variants, this field only counts products. This field can be used to track operation progress.
Anchor to statusstatus • BulkOperationStatus!non-null: Status of the bulk operation.
Anchor to typetype • BulkOperationType!non-null: The bulk operation's type.
Anchor to urlurl • URL: The URL that points to the response data in JSONL format. The URL expires 7 days after the operation completes.

Was this section helpful?

Anchor to QueriesQueries

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

Was this section helpful?

Anchor to MutationsMutations

Anchor to bulkOperationCancel bulkOperationCancel • mutation: Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.
Anchor to bulkOperationRunMutation bulkOperationRunMutation • mutation: Creates and runs a bulk operation mutation.

To learn how to bulk import large volumes of data asynchronously, refer to the bulk import data guide.
Anchor to bulkOperationRunQuery bulkOperationRunQuery • mutation: Creates and runs a bulk operation query.

See the bulk operations guide for more details.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?