Bulk
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.
Anchor to FieldsFields
- Anchor to completedAtcompleted•Date
At Time When the bulk operation was successfully completed.
- Anchor to createdAtcreated•Date
At Time!non-null When the bulk operation was created.
- Anchor to errorCodeerror•Bulk
Code Operation Error Code Error code for failed operations.
- Anchor to fileSizefile•Unsigned
Size Int64 File size in bytes of the file in the
urlfield.- •ID!non-null
A globally-unique ID.
- Anchor to objectCountobject•Unsigned
Count Int64!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 partialDataUrlpartial•URL
Data 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
nullwhen there's no data available.- Anchor to queryquery•String!non-null
GraphQL query document specified in
.- Anchor to rootObjectCountroot•Unsigned
Object Count Int64!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•Bulk
Operation Status!non-null Status of the bulk operation.
- Anchor to typetype•Bulk
Operation Type!non-null The bulk operation's type.
Anchor to QueriesQueries
- •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.
Anchor to MutationsMutations
- •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.
- •ID!required
The ID of the bulk operation to cancel.
Arguments
- Anchor to bulkOperationbulk•Bulk
Operation Operation The bulk operation to be canceled.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 clientIdentifierclient•String
Identifier An optional identifier which may be used for querying.
- Anchor to groupObjectsgroup•Boolean!requiredDefault:true
Objects Whether to group objects under their corresponding parent objects in the JSONL output. Grouping is costly, causes bulk operations to take longer to complete, and increases the chances of failures such as timeouts.
- Anchor to mutationmutation•String!required
The mutation to be executed in bulk.
- Anchor to stagedUploadPathstaged•String!required
Upload Path The staged upload path of the file containing mutation variables.
Arguments
- Anchor to bulkOperationbulk•Bulk
Operation Operation The newly created bulk operation.
- Anchor to userErrorsuser•[Bulk
Errors Mutation User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates and runs a bulk operation query.
See the bulk operations guide for more details.
- Anchor to groupObjectsgroup•Boolean!requiredDefault:true
Objects Whether to group objects under their corresponding parent objects in the JSONL output. Grouping is costly, causes bulk operations to take longer to complete, and increases the chances of failures such as timeouts.
- Anchor to queryquery•String!required
The query to be executed in bulk.
Arguments
- Anchor to bulkOperationbulk•Bulk
Operation Operation The newly created bulk operation.
- Anchor to userErrorsuser•[Bulk
Errors Operation User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields