CustomField

A single custom field.

More info: see the get operation and the custom fields endpoint.

Fields

Field	Description
id int (required)	Unique ID Example value:`123`
typeid int (required)	Type ID Example value:`13001`
availability CustomfieldAvailability (required)	Rules that define in what conditions this custom field is available when edit type is `checkout` Example value:`{ "saleschannels": [ 14 ], "usescript": false }`
caption mlstring (required)	Human-readable name for the custom field Example value:`"Genre"`
description mlstring (required)	Human-readable description for the custom field. Will be visible for end-users when edittype `checkout` is used Example value:`"Where have you heard from us?"`
edittypeid int (required)	Type of editing that is allowed for the custom field. Links to systemtype category 22xxx Example value:`22002`
fieldtypeid int (required)	Type of the custom field. Links to systemtype category 12xxx Example value:`12001`
key string (required)	The identifier for the custom field. Should contain only alphanumeric characters and no whitespace, max length is 30 characters. The custom field will be available in the api and the public data model as c_ Example value:`"genre"`
manualsort bool (required)	Indicated whether the field is manually sortable
requiredtypeid int (required)	Indicates where the custom field is required. Links to systemtype category 30xxx Example value:`30002`
isarchived bool (required)	Whether or not this item is archived
createdts timestamp (required)	Created timestamp Example value:`"2014-09-26 15:24:36"`
lastupdatets timestamp (required)	Last updated timestamp Example value:`"2014-09-26 15:24:36"`

Example

 1{
 2    "id": 123,
 3    "typeid": 13001,
 4    "availability": {
 5        "saleschannels": [ 14 ],
 6        "usescript": false
 7    },
 8    "caption": "Genre",
 9    "description": "Where have you heard from us?",
10    "edittypeid": 22002,
11    "fieldtypeid": 12001,
12    "key": "genre",
13    "manualsort": false,
14    "requiredtypeid": 30002,
15    "isarchived": false,
16    "createdts": "2014-09-26 15:24:36",
17    "lastupdatets": "2014-09-26 15:24:36"
18}