Specifies whether the provider uses Shopify Bulk Operations when querying data through the GraphQL schema. This property has no effect when using the REST API schema. This property is useful when you are querying high-volume datasets, such as thousands of orders, products, or customers and want to optimize performance or reduce the likelihood of API throttling from real-time queries.

Data Type

bool

Default Value

false

Remarks

Use this property only when the Schema property is set to a GRAPHQL-value. When set to true, the server submits GraphQL queries using Shopify's Bulk Operations API. This allows the server to handle large data sets more efficiently by running asynchronous export jobs behind the scenes. The server monitors job status and retrieves the results once they are available.

Note: The Shopify Bulk API has several limitations and is primarily suited for data replication tasks. Shopify allows only one bulk operation to run at a time per shop. If a second operation is started before the first completes, it fails. Disabling parallel operations or concurrent execution in your client application or custom implementation code does not guarantee prevention of conflicts caused by the Bulk API's single-operation limit. Additionally, each bulk query operation must complete within 10 days. Otherwise, the operation is terminated and marked as failed. Furthermore, certain tables and columns that do not meet the requirements of the Bulk API are not exposed when this property is enabled. Evaluate whether your use case is better served by asynchronous bulk jobs or real-time GraphQL queries.

Use BulkPollingInterval, BulkTimeout, and BulkPageSize to tune responsiveness and resource usage.