Salesforce Docs Portal

Custom JSON for Order Items

Custom JSON for Order Items controls the name and display behavior of the order and product fields on the Order Items page.

Required Editions

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled

Attribute Data Type Required Default Description
active Boolean   FALSE Defines if the field is active and shown in order items.
ascending Boolean   FALSE Defines if the field is by default sorted in ascending or descending order.
columnsConfiguration Object Yes   Key to list the fields in the grid.
defaultTab String No AllItems

Defines the default tab shown for an order.

Possible Values are:

  • Basket
  • AllItem
editable Boolean   FALSE Defines if the field is editable when the order is in Edit mode.
fieldApiName String Yes   API name of the field.
fieldLabel String   Field label Custom label.
fieldType String   text Defines the data type of the field in the grid.
fixedColumns Integer   2 Number of fixed columns in the grid.
hierarchicalSearch Boolean   FALSE Determines if order items are filtered by hierarchical and dynamic product filtering options.
isFilter Boolean   FALSE Defines if the values in the field can be filtered.
isPickList String   FALSE Defines if the field is shown as a multi-select picklist on the page.
maxNumberUpdates Integer   1000 Maximum number of updates in the grid.
maxWidth String     Defines the maximum width of the field in the grid.
minWidth String     Defines the minimum width of the field in the grid.
objectApiName String Yes   API name of the object.
order Integer     Defines the display position of the field in the grid.
orderItems Object Yes   Key attribute.
required Boolean   FALSE Defines if the required icon is to be shown in the grid for the field.
sortable Boolean   FALSE Defines if the field is sortable in the grid.
typeAttributes Object   {}

Can be one of:

  • maxLength - maximum characters You can input while editing.
  • maximumFractionDigits - maximum number of decimals for the field.
visible Boolean   FALSE Identifies if the field is visible in the grid.
width String   Calculated based on the total number of fields present. Identifies the width of the field in the grid.