Customizable Grids

A customizable grid lets the administrator define how the customer search result appears. Customizable grids consist of columns that define what appears in the particular grid.

The columns contain a title to define the column header manually. If the title is empty, the column header is generated based on the metadata of the attribute defined for that column. If the column contains multiple attributes, the column header remains empty. A layout is defined for each column containing an attribute or an array of attributes that define where the data comes from. Those attributes are resolved against the specific grid data source.

Supported customizable grids are listed in the remaining sections of this guide.

Customer Search

Source: Customer

1{
2  "columns": [
3    {
4      "label": "Name",
5      "layout": {
6        "layout": [
7          { "attribute": "first_name" },
8          { "attribute": "last_name", "suppress_new_column": true }
9        ]
10      }
11    },
12    {
13      "layout": { "attribute": "email" }
14    },
15    {
16      "layout": { "attribute": "company_name" }
17    }
18  ]
19}

Customer Baskets

Source: Basket

1{
2  "columns": [
3    {
4      "layout": {
5        "attribute": "last_modified"
6      }
7    },
8    {
9      "label": "Items",
10      "layout": {
11        "xpath": "replace(trim(concat(/product_items[1]/product_name , '\n' , /product_items[2]/product_name, '\n' , /product_items[3]/product_name )),'\n',', ')",
12        "meta": { "type": "string" }
13      }
14    }
15  ]
16}

Admins can configure the Customer Baskets grid by defining both system and custom attributes. All columns can contain consolidated content and can have custom labels. The column can be defined with either attribute or xpath, for example:

1concat('First Product: ', /product_items[1]/product_name)

Customer Orders

Source: Order

1{
2  "columns": [
3    {
4      "label": "Items",
5      "layout": {
6        "xpath": "replace(trim(concat(/product_items[1]/product_name , '\n' , /product_items[2]/product_name, '\n' , /product_items[3]/product_name )),'\n',', ')",
7        "meta": { "type": "string" }
8      }
9    },
10    {
11      "layout": {
12        "attribute": "creation_date"
13      }
14    },
15    {
16      "layout": {
17        "attribute": "status"
18      }
19    }
20  ]
21}

Customer Address Book

Source: CustomerAddress

1{
2  "columns": [
3    {
4      "layout": {
5        "attribute": "preferred"
6      }
7    },
8    {
9      "layout": {
10        "attribute": "full_name"
11      }
12    },
13    {
14      "layout": {
15        "attribute": "postal_code"
16      }
17    },
18    {
19      "layout": {
20        "attribute": "city"
21      }
22    },
23    {
24      "layout": {
25        "attribute": "state_code"
26      }
27    },
28    {
29      "layout": {
30        "attribute": "phone"
31      }
32    }
33  ]
34}

Order Search

Source: Order

1{
2  "columns": [
3    {
4      "layout": {
5        "attribute": "customer_name"
6      }
7    },
8    {
9      "layout": {
10        "attribute": "customer_info.customer_no"
11      }
12    },
13    {
14      "label": "Items",
15      "layout": {
16        "xpath": "replace(trim(concat(/product_items[1]/product_name , '\n' , /product_items[2]/product_name, '\n' , /product_items[3]/product_name )),'\n',', ')",
17        "meta": { "type": "string" }
18      }
19    },
20    {
21      "layout": {
22        "attribute": "creation_date"
23      }
24    },
25    {
26      "layout": {
27        "attribute": "status"
28      }
29    }
30  ]
31}