BulkOperation object
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
rootObjectCount (
UnsignedInt64!
)The running count of all objects processed at the root of the query. For example, when fetching all products and their variants, this field counts only products. This field can be used to track operation progress.
-
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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.
See the bulk operations guide for more details.
-
Creates and runs a bulk operation query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
rootObjectCount (
UnsignedInt64!
)The running count of all objects processed at the root of the query. For example, when fetching all products and their variants, this field counts only products. This field can be used to track operation progress.
-
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
rootObjectCount (
UnsignedInt64!
)The running count of all objects processed at the root of the query. For example, when fetching all products and their variants, this field counts only products. This field can be used to track operation progress.
-
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
rootObjectCount (
UnsignedInt64!
)The running count of all objects processed at the root of the query. For example, when fetching all products and their variants, this field counts only products. This field can be used to track operation progress.
-
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
rootObjectCount (
UnsignedInt64!
)The running count of all objects processed at the root of the query. For example, when fetching all products and their variants, this field counts only products. This field can be used to track operation progress.
-
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.
Implements
An asynchronous long-running operation to fetch data in bulk.
Bulk operations are created using the bulkOperationRunQuery
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.
See the bulk operations guide for more details.
Fields
-
completedAt (
DateTime
)When the bulk operation was successfully completed.
-
createdAt (
DateTime!
)When the bulk operation was created.
-
errorCode (
BulkOperationErrorCode
)Error code for failed operations.
-
fileSize (
UnsignedInt64
)File size in bytes of the file in the
url
field. -
id (
ID!
)Globally unique identifier.
-
objectCount (
UnsignedInt64!
)The running count of all objects processed. For example, when fetching all products and their variants, this field counts both products and variants. This field can be used to track operation progress.
-
query (
String!
)GraphQL query document specified in
bulkOperationRunQuery
. -
status (
BulkOperationStatus!
)Status of the bulk operation.
Types that return BulkOperation
Mutations for BulkOperation
-
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 query.
See the bulk operations guide for more details.