Documentation Portal

DefaultValue

String

In some cases, some fields should be prefilled with default values (for example, Hong Kong city in the Hong Kong country).

DescriptionInCulture

String

Additional textual information about the field (to be used as a watermark, tooltip, and more).

IsRequiredForOrder

Boolean

Indicates if field is mandatory before completing or paying an order.

TRUE - Field is mandatory before completing/paying order.

FALSE - Field is not mandatory.

IsRequiredForShipping

Boolean

Indicates if this field is mandatory for final shipping prices (due to remote area surcharge, which requires additional information and not just the country). This setting applies to City and ZipCode or if the Merchant chooses not to subsidize the remote area surcharge.

TRUE - Field is mandatory for shipping price calculations.

FALSE - Field is not mandatory.

IsRequiredForTaxes

Boolean

Indicates if this field is mandatory for tax calculation. After all field settings are TRUE and have values, the UpdateAddress method returns the tax information. Depending on the shipping country, this setting can be TRUE for State, City, Address1, Address2, ZipCode (for example, the US sales tax uses the street name to calculate the actual tax cost).

TRUE - Field is mandatory for tax calculations.

FALSE - Field is not mandatory.

MaxLength

Decimal

The maximum number of characters allowed for a textual field (string). If it is not textual, this field is null.

Name

String

Name of the checkout field in English.

NameInCulture

String

Name of the checkout field in the checkout culture.

Regex

String

For textual fields, if applicable, a regex indicating the required field validation (preferably on the client side).

Type

String

Type of the field (string, numeric, list).