Object

Object metadata stores structured values. Use it when one field contains multiple named properties, such as location data.

Value Shape

type ObjectMetadataValue = Record<string, unknown> | null;

Guard object values before reading properties:

const location = record.data.delivery_location;
const locationData =
  location && typeof location === 'object' && !Array.isArray(location)
    ? location as Record<string, unknown>
    : {};

Common Uses

Use	Examples
Location	Address, coordinates, country, city
Structured data	Related properties stored as one field