/property-definitions

post

https://api.dev.orbit.do/v5/property-definitions

Create a property definition for custom properties on entities.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Property definition to create. Supports types: text, number, checkbox, select, multiselect, document.

array of strings

required

Entity types this custom field can be attached to (e.g. shipment, tour, order, carrier, vehicle). One definition may apply to several types.

on*

localizedName

object

The field's display label per language, e.g. { en: 'Service level', de: 'Servicelevel' }. At least one language must be non-empty. Renameable later without changing the id.

localizedDescription

object

Optional per-language description of what this field means and how to fill it (e.g. { en: 'ADR class of the load; leave empty for non-hazardous goods.' }). Shown as help text to users and included in agent context — write it for both audiences. Maximum 500 characters per language.

type

string

enum

required

The field's data type; fixes how its value is stored and validated. "select"/"multiselect" require selectValues; "document" stores a file link.

Allowed:

length ≤ 36

^[a-zA-Z0-9-]+$

Optional stable id for the definition (≤ 36 chars, letters/digits/hyphen; case-insensitively unique per tenant). Omit to have the server generate a UUID. This is the tenant-specific key later config/values reference — not the label.

selectValues

array of objects

The allowed options for a "select"/"multiselect" field; each option has its own id (the stored value) and a localized name. Omit for other types.

selectValues

color

string

required

length ≥ 1

UI display color for the field's chip/badge.

icon

string

required

length ≥ 1

UI display icon name for the field.

Responses

400

Bad request - validation error or duplicate ID

401

Unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created property definition