v1

latestOpenAPI 3.0.32026-08-06111223.1 KB

Orders

Get Order Fields

Returns the available fields for creating orders, including core fields and custom fields configured by the tenant.

get/api/order-fields

Response

Order field definitions

Example response

{
  "core_fields": [
    {
      "key": "order_number",
      "label": "Order #",
      "type": "text",
      "required": true
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "key": "client_name",
      "label": "Client Name",
      "type": "text",
      "options": [
        "Option 1",
        "Option 2"
      ],
      "help_text": "Enter the client's full legal name"
    }
  ]
}