UseCustomFields Property

In This Topic

Determines whether you will be able to get product custom fields via the CustomFields field of the Products object through this connection.

Syntax

Visual Basic
C#

'Declaration
 
Public Property UseCustomFields As Boolean

public bool UseCustomFields {get; set;}

Property Value

true, if CustomFields field of the Products object should return information about custom fields and their values for products when such are available; otherwise, false. Default value is false.

Remarks

Applicable only for BigCommerce API v3 connections. If set to True, this field returns a JSON array, containing information about custom fields and their values for products, if such are available. Otherwise, it always returns null values.

This parameter does not affect working with custom fields for customers and customer addresses, and it also does not affect access to product custom fields via the ProductCustomFields object.

Please note that processing custom fields may take an additional time and API calls, so it's recommended to set this parameter to True only if you need to work with product custom fields via this connection.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

BigcommerceConnectionStringBuilder Class
BigcommerceConnectionStringBuilder Members

Send Feedback