Property Type

Every property belongs to a certain type which can be one of the following:

String (referred in tables as 'string')

  • any string can be assigned to a property

Integer (referred in tables as 'integer' or 'int')

  • any integer numbers can be assigned to a property

  • if a request of Inbound API transaction contains a property of 'integer' type but with non-numeric value and the property visibility is not 'mandatory', the property is ignored and a warning is sent in the response

  • if a request of Inbound API transaction contains a property of 'integer' type but with non-numeric value and the property visibility is 'mandatory', the request is rejected with the corresponding error

Regular Expression (referred in tables as 'regexp')

  • some string and integer properties have a regular expression pattern that restricts possible values

  • if a request of Inbound API transaction contains a 'regex' property with a value not matching regular expressions and the property visibility is not 'mandatory', the property is ignored and a warning is sent in the response

  • if a request of Inbound API transaction contains a 'regex' property with a value not matching regular expressions and the property visibility is 'mandatory', the request is rejected with the corresponding error

Enumeration (referred in tables as 'enum')

  • only values of a fixed subset of integers can be assigned to a property

  • the subset is defined for the property and cannot be configured

  • the subset values are provided herein

Key (referred in tables as key)

  • only values of a fixed subset of integers can be assigned to a property

  • the subset is configurable for each specific company

Note: In the following sections the property table contains 'name' of the property, its visibility, type and length and description. Length is the value in the brackets by the property type. If the length is not specified then the Inbound API does not check it or it makes no sense (e.g. 'external_id', 'language' are matched against the predefined set of values).