Data Types

The VoyageOne API only supports JSON for both API requests and responses. Here you can view the list of supported JSON data types.

Data Type Description Example
string A string of Unicode characters enclosed in quotation marks.

When quotation marks, semicolons or apostrophes are used within the string, they must be escaped. A single backslash serves as the escape character for the quotation mark (") and semicolon (;). A double backslash serves as the escape character for the apostrophe (¡®).

Valid special characters are: ~!@#$%^&*()_+{}|:¡±<>?`-=[];',./		 {
"color": "Red \"Hot\" Purple",
}

{
"color": "Red \\'Hot\\' Purple",
}
number It is a JSON data type which is used to represent a number. It is a double-precision floating-point format in JavaScript. {
"priceMsrp": 210,
"priceRetail": 210.00,
"priceCost": 199.99
}
boolean An unquoted lowercase literal string of true or false. {
"alive": true
}
null An unquoted lowercase literal string of null. {
"shortDescription": null
}
object An unordered set of name/value pairs inserted between curly braces. An object can contain zero or more name/value pairs. Multiple name/value pairs are separated by a comma. {
"color": "Purple",
"priceCost": 199.99,
"alive": true
}
array An ordered list of values or objects. Begins with a left square bracket and ends with right square bracket. The values are separated by comma. ["1.jpg","2.jpg","3.jpg"]

[
{"gender": "female"},
{"season": "Fall"}
]