An asynchronous long-running operation to fetch data in bulk or to bulk import data.
Bulk operations are created using the or mutation. After
they are created, clients should poll the status field for updates. When , the url field contains
a link to the data in JSONL format.
Refer to the bulk operations guide for more details.
When the bulk operation was successfully completed.
When the bulk operation was created.
Error code for failed operations.
File size in bytes of the file in the
urlfield.A globally-unique ID.
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.
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
nullwhen there's no data available.GraphQL query document specified in
.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.
Status of the bulk operation.
The bulk operation's type.
The URL that points to the response data in JSONL format. The URL expires 7 days after the operation completes.
Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.
Mutations
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.
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.
Creates and runs a bulk operation query.
See the bulk operations guide for more details.