Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Workflows

Define a new custom field

Create a new custom field definition for a given entity type.

🔒 Requires: custom_fields:write scope

post/workflows/custom_fields

Request body

editable_in_uiboolean

Should this custom field be editable in the UI.

entity'sale' | 'line_item' | 'customer' | 'product' required

The type of entity.

namestring required
print_on_receiptboolean

Should this custom field be printed on receipts.

titlestring required
type'string' | 'integer' | 'boolean' | 'date' | 'product_id' | 'qrcode' | 'string_array' required

The type of the value to be stored using this custom field.

visible_in_uiboolean

Should this custom field be visible in the UI.

Example request

{
  "name": "my_custom_field",
  "title": "My Custom Field"
}

Response

A custom field definition.

Example response

{
  "data": {
    "id": "1239349157873029120",
    "name": "my_custom_field",
    "title": "My Custom Field"
  }
}