Home > API Fields


API Fields

Formatting Restrictions

Unless otherwise noted, all of the fields listed are order and case insensitive, and the fields accept special characters, such as @, #, and %.

Order-level and offer-level field names and values must not contain carets (^) or colons (:). However, they can contain embedded spaces and any other printable characters. If you use more than one consecutive space, the extra spaces are removed.

Data Type Definitions

For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: Datatypes Second Edition.

Table 15Data Type Definitions

Data Type

Description

Date and time

Format is YYYY-MM-DDThhmmssZ, where:

nT separates the date and the time

nZ indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT)

Example  2020-01-11T224757Z equals January 11, 2020, at 22:47:57 (10:47:57 p.m.)

Decimal

Number that includes a decimal point

Example  23.45, -0.1, 4.0, 90809.0468

Integer

Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}

Nonnegative integer

Whole number greater than or equal to zero {0, 1, 2, 3, ...}

Positive integer

Whole number greater than zero {1, 2, 3, ...}

String

Sequence of letters, numbers, spaces, and special characters