Documentation / API / Data Types

All the different data types for JSON tags are explained here.

Boolean

Reprensents a bolean value (true or false).

{
    'tag': 'true'
}

DateTime

Reprensents a date or date and time, which can be of format yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. No other date or date and time formats will be accepted.

{
    'tag': '2018-01-05 15:33:16'
}

Decimal

Reprensents a (positive or negative) number with decimals and no separators. Value must be between -79,228,162,514,264,337,593,543,950,335.00 and 79,228,162,514,264,337,593,543,950,335.00 (separators added just for reading clarity, will not be accepted in a request).

{
    'tag': '-1645.35125'
}

GUID

Reprensents a GUID (Globally Unique ID) which consists of something like this: 00000000-0000-0000-0000-000000000000.

{
    'tag': '12345678-1234-1234-1234-123456781234'
}

Integer

Reprensents a (positive or negative) number with no decimals and no separators. Value must be between -2,147,483,648 and 2,147,483,648 (separators added just for reading clarity, will not be accepted in a request).

{
    'tag': '-46589115'
}

String

Reprensents a series of characters (text).

{
    'tag': 'string value...'
}

Predefined Values

Some of the values are predefined. If you don't use one of those specific values, the response will return an error.

Applies-to

{ 
    "EVERYWHERE", 
    "COUNTRY", 
    "STATE", 
    "ZIP" 
}

Coupon types

{ 
    "AMOUNT_ORDER", 
    "AMOUNT_ITEM", 
    "PERCENTAGE_ORDER", 
    "PERCENTAGE_ITEM", 
    "AMOUNT_SHIPPING", 
    "FREE_SHIPPING" 
}

Languages

{ 
    "en-US", 
    "fr-CA" 
}

Order status

{ 
    "PENDING", 
    "WAIT_PAYMENT", 
    "PROCESSING",
    "WAIT_PICKUP", 
    "PAYMENT_RECEIVED", 
    "PARTIALLY_SHIPPED", 
    "SHIPPED", 
    "COMPLETED", 
    "CANCELLED", 
    "REFUNDED" 
}

Payment types

{ 
    "INSTANT", 
    "WIRE", 
    "COD", 
    "CHECK", 
    "CASH" 
}

Product types

{ 
    "PHYSICAL", 
    "VIRTUAL" 
}

Provider types

{ 
    "CANADAPOST", 
    "FEDEX", 
    "PUROLATOR", 
    "UPS", 
    "USPS", 
    "AUSTRALIAPOST", 
    "ROYALMAIL", 
    "DHL", 
    "OTHER" 
}

Shipping types

{ 
    "FIXED", 
    "REALTIME", 
    "PICKUP" 
}

Shipping fixed types

{ 
    "FLAT_ORDER", 
    "FLAT_ITEM", 
    "PERCENTAGE_ORDER", 
    "PERCENTAGE_ITEM" 
}

User roles

{ 
    "ADMIN",
    "MANAGER", 
    "SUPERVISOR", 
    "OPERATOR", 
    "VENDOR", 
    "DESIGNER" 
}