IncludeCustomFields
Specifies whether the provider includes custom fields in queries to the Products and ProductVariants tables.
Data Type
bool
Default Value
false
Remarks
Set this property to true to include custom fields, such as metafields, when querying or updating records in the Products and ProductVariants tables.
This functionality is supported in:
- REST schema
- GraphQL schema when UseBulkAPI is set to false
When set to false, the server skips custom field processing to improve performance, especially during large reads. However, with this setting disabled, you cannot read or update custom fields in these tables.
This property is useful when you need access to Shopify metafields or other extended product metadata.