In the documentation of API methods, each field specifies its data type:
| Data type | Example | Description |
|---|---|---|
bool |
true |
Boolean, takes the values true and false. |
string |
"shirt" |
Unicode string (UTF-8). It can have a minimum and maximum length. |
int |
125 |
Signed integer. Unless otherwise specified, the minimum is -2147483648 and the maximum is 2147483647. |
decimal[precision,digits] |
172.95 |
Signed decimal. precision is the total number of digits while digits is the number of digits after the decimal point. Unless otherwise specified, the minimum and maximum are still determined by precision and digits. |
date |
"2020-09-01" |
Date in the "yyyy-mm-dd" format. |
datetime |
"2020-09-01 12:05:38" |
Date and time in the "yyyy-mm-dd hh:mm:ss" format. |
A string can have a minimum and maximum length:
string(min…max) // length between min and max, example: string(1…32)
string(min…) // minimum length min, example: string(10…)
string(len) // length len, example: string(15)
Integers and decimals can have a minimum and a maximum that limit their value range:
int(min…) // minimum min, example: int(1…)
int(…max) // maximum max, example: int(…120)
decimal[p,d](min…max) // minimum min and maximum max, example: decimal[10,3](0…10000)
A field in a request is required only if it is marked with "(required)" in the field documentation.
null fieldsA field can have the value null only if it is marked with "(can be null)" in the field documentation.