UseBulkAPI
Specifies whether the provider uses Shopify Bulk Operations when querying data through the GraphQL schema.
Data Type
bool
Default Value
false
Remarks
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.
Use this property only when the Schema property is set to a GRAPHQL-value. 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.
Note: Shopify allows only one bulk operation to run at a time per shop. If a second operation is started before the first completes, it will fail. 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.