Data types

Int

Integer number (ex: 2, 117, -9). Value is between -9223372036854775808 and 9223372036854775807.

String

Text limited to 255 characters.

ID

Same as Int

Float

Float number. Depending on the data, the maximum value and the number of decimals could be different :

for a quantity : 17 digits, 7 after the decimal point
for a cost : 14 digits, 4 after the decimal point
for a price : 10 digits, 2 after the decimal point
for a weight : 10 digits, 4 after the decimal point
for a percentage : 5 digits, 2 after the decimal point (except for a currency rate : 12 digits, 6 after the decimal point)

Boolean

Boolean value (true / false). The API could return also 0 (false) and 1 (true)

Date

Date (format : YYYY-MM-DD)

DateTime

Date and time (format : YYYY-MM-DD HH:MM:SS)

Mixed

Value whose type depends on the field it belongs to. Used by custom fields, where value returns the same type as the underlying text_value, number_value, boolean_value, date_value, or datetime_value field.

Decimal

Decimal number. Returned as a Float value; the number of decimals available depends on the data, as described above.

Object

Structured object made of named fields, passed as an input. Each object has its own input type documented on the page of the mutation that uses it.

Enum

Fixed list of possible values, always written without quotes. Each enum is documented on the page of the entity it belongs to.

Union

Value that can take one of several object types. The possible types are listed in the documentation of the field.

JSON

JSON (JavaScript Object Notation) object. Used for complex structured data like settings, configurations, or nested objects.

Structure :

Key-value pairs: {"key": "value"}
Nested objects: {"parent": {"child": "value"}}
Arrays: {"items": ["item1", "item2"]}

Exemples dans l'API :

pdf_settings : Configuration des templates PDF (~60 options)
custom_fields : Valeurs de champs personnalisés
metadata : Métadonnées additionnelles

Exemple :

{
  "displaySKU": true,
  "paperSize": "A4",
  "primaryColor": "rgb(106, 106, 106)"
}