Data Types & Formats

All dates and timestamps use ISO 8601 format (UTC).

Date-Time Format

2025-10-15T14:30:00Z

Date-Only Format

2025-10-15

Example in Response

{
  "created": "2025-10-15T14:30:00Z",
  "sale_date": "2025-10-15"
}

Currency amounts are represented as strings to preserve precision.

Basic Amount

{
  "amount": "1250.50"
}

Formatted Amount

Some responses include formatted values with currency symbols:

{
  "balance": {
    "value": "1250.50",
    "formatted": "$1,250.50"
  }
}

Boolean values can be represented in multiple ways:

• true / false
• 1 / 0
• "1" / "0"

Example

{
  "lots_locked": true,
  "archived": 0,
  "active": "1"
}

Handling of null or empty values:

• Missing optional fields may be omitted entirely
• Explicitly null fields: null
• Empty strings: ""

Example

{
  "phone": "+1-555-0123",
  "fax": null,
  "notes": ""
}

Collections of items are returned as arrays:

{
  "data": [
    {"id": "1", "label": "Item 1"},
    {"id": "2", "label": "Item 2"}
  ],
  "count": 2
}

Entity IDs are typically represented as strings:

{
  "id": "123",
  "uuid": "abc-def-123",
  "order_id": "12345"
}

Reference Objects

Related entities are often represented as objects with ID and label:

{
  "sale": {
    "id": "456",
    "label": "Summer Auction 2025"
  },
  "owner": {
    "id": "123",
    "label": "John Doe"
  }
}

Enumerated values (status, type, etc.) are returned with ID and label:

{
  "status": {
    "id": "approved",
    "label": "Approved"
  },
  "type": {
    "id": "bidder",
    "label": "Bidder Order"
  }
}

When sending data, use the ID value:

{
  "status": "approved",
  "type": "bidder"
}