1 Introduction
2 Entities table
3 Display the correct field
4 Specific formatting
- 4.1 Syntax
- 4.2 Parenthesis
- 4.3 All formats available

Introduction

As a prerequisite, you need to ensure that the fields you want to display are actually retrieved in the query. For more information, click here Retrieving data from pages

What we call ‘displayed properties’ is the information displayed on all Store App display blocks, at different levels (orders, lines, parcels, etc) as well as in the popins.

You can find the displayed properties configuration in the Configuration > Store App > Page settings > {Page name} > Displayed properties section of your admin backoffice.

The default configuration is displayed, but it can be overwritten. In general, property blocks are organised into 3 lines, each of which can be overloaded independently

Tip: to return to the default configuration, click on the wheel and then ‘return to default configuration’.

Entities table

In each page, the display blocks correspond to particular entities, and it is sometimes difficult to navigate. You can use the table below to find the names of the entities used page by page.

Page	Entities	Sections

Page	Entities	Sections
Claim	Order Line item group	Classic claim page
Picking	Endpoint order Piece group Order	Picking page before selection Picking page after selection
Prepare (select)	Endpoint order Piece group	Classic prepare select page
Pack	Order Line item group Order multi Multi container Endpoint order Piece group	Classic pack page Classic pack page with “multi parcel” allowed Pack page in “Store as a Warehouse” mode (when the container is contained in a cell, a parking or a trolley).
Pack - scan	Order Line item group Order multi Multi container Endpoint order Piece group Carrier pop-in Parcel	Classic pack scan page before selection Pack scan page before selection with “multi parcel” allowed Classic pack scan page after selection Pack scan page after selection with “multi parcel” allowed Document printing pop-in after scan Pack scan page in “Store as a Warehouse” mode (when the container is contained in a cell, a parking or a trolley).
Dispatch	Parcel Line item Group Shipment manifest	Classic dispatch page Dispatch page with the “need_shipment_manifests” option enabled
Bag	Order Line item group Order multi Multi container Endpoint order Piece group	Classic bag page Classic bag page with “multi parcel” allowed Bag page in “Store as a Warehouse” mode (when the container is contained in a cell, a parking or a trolley)
Bag - scan	Order Line item group Order multi Multi container Endpoint order Piece group Carrier pop-in	Classic bag scan page before selection Bag scan page before selection with “multi parcel” allowed Classic bag scan page after selection Bag scan page after selection with “multi parcel” allowed Document printing pop-in after scan Bag scan page in “Store as a Warehouse” mode (when the container is contained in a cell, a parking or a trolley).
Receive	Parcel Line item group	Classic receive page
Collect	Order Bag Box Line item group	Classic collect page
Reserve	Order Line item group	Classic reserve page
Carry	Parcel Bag Line item group	Classic carry page
Catalog	Basket Line item	Basket page of the catalog
Catalog	Basket CRM Item	Basket CRM page of the catalog
Catalog	Basket customer payment Customer	Basket customer payment page of the catalog
Catalog	Basket Shipping options customer address delivery promise information	Basket Shipping options of the catalog
Catalog	Product Item information Store	Product page of the catalog
Order list	Endpoint order Piece group	Classic orders list page
Sorting		Sorting page before scan Sorting popin for item scan
Moving
Boxing
Users	User
Customer search		Before selection After selection with a shipped parcel After selection with a processing parcel Return popin After selection with a return Return details pop-in

If the multi-parcel configuration is enabled, use the display property blocks named 'multi xx'

Display the correct field

It's not easy to find the right path for the field you want to display, especially as the logic depends on each page.

The best way is to use the paths configured by default on the entity, and try to reproduce the same path with the field you want to add.

Example:

containers.0.parcel.delivery.carrier.name displays the name of the carrier in the ‘order’ section of the pack page

Specific formatting

Syntax

Properties often need to be formatted for aesthetic reasons.

It is possible to use one or more formats with the following syntax field|formatter1:option|formatter2|formatter3.

In the absence of parentheses, formats are applied from left to right.

Examples:

to capitalize the first letter of the delivery type, use delivery.type|capitalize
to retrieve the 3rd element of an array (index 2), I'll use delivery.destination.address.lines|arrayelement:2

The format |rawstring:must be applied to the left of the field, unlike the other

Parenthesis

A parenthesis syntax is available for the most complex expressions.

Properties that are nested within parentheses will be evaluated first.

Example:

The following property will display 1 / 2.

parcels|forcount:line_item_ids|concatraw: / |concatraw: (line_item_groups|length)

All formats available

Name	Description	Option	Example → Render

Name	Description	Option	Example → Render
`arrayelement`	Retrieves the element of an array with index.	Element index	`types\|arrayelement:0`→ ffs
`capitalize`	Replace all letters with lower case, except the first, which is upper case.		`features.name\|capitalize` → Summer dress
`concat`	Concatenates another property, without spaces.	Property to concatenate	`carrier\|concat:tracking_code` → ups64477466854
`concatraw`	Concatenates a string.	Defined string	`state\|concatraw:from warehouse` → dispatched from warehouse
`currency`	Formats a number into a currency, with a symbol defined in another property.	Property containing the currency	`payment.price\|currency:payment.currency` -> 35,99 £
`currencyraw`	Formats a number into a currency, with a symbol defined in the expression.	The currency to use	`payment.price\|currencyraw:USD` → 35,99 $
`dateto`	Format a date range.	Property corresponding to end date	`eta_start\|dateto:end_end` → 27 - 30 september
`divide_by`	Divides a value of a property by an another.	Divisor property	`order_item.pricing_details.price\|divide_by:order_item.quantity` → 3 (price = 6 and quantity = 2)
`expirationcolor`	Returns a date in the color sent if expired. It is possible to pass a relative parameter (seconds to be subtracted from the expiry date).	The warning value to be subtracted from the current date for the calculation (in seconds) The color to be set if the date has expired. The value to be returned.	`expiration_dates.client_collect.expiration\|expirationcolor:86400,danger,(expiration_dates.client_collect.expiration\|moment:DD/MM/YYYY\|transcount:carry.reserved_till)` → Reserved until 10-02-2023
`filter`	Scans an array and keeps the elements of this array whose property is worth one of the values provided.	Comma-separated list of values	`line_item_groups\|filter:state=removed,mistaken\|length\|concatraw: items sont removed ou mistaken` → 5 items sont removed ou mistaken
`filterlength`	Scans an array and counts the number of elements in the array whose property has one of the provided values.	Comma-separated list of values	`line_item_groups\|filterlength:state=removed,mistaken\|transcount:order.cancel_count` → 5 canceled
`forcount`	Scans an array and counts the size of each property in the array.	Property	`parcels\|forcount:piece_ids\|transcount:order.item_count` → 5 items
`hierarchicalchoose`	Scans an array and returns the element with the lowest index in the array defined in option . If nothing matches, does nothing.	Comma-separated list of values	`types\|hierarchicalchoose:ois,ckc,ffs` → ckc
`highlight`	Change the color of the text to red. It should be the last format because it will put the text into a span tag.		`parcels\|forcount:piece_ids\|transcount:order.item_count\|highlight` → 5 items
`index_ranges_quantity`	Calculates the total quantity of indexes in the supplied index ranges.		`parcel.line_item_index_ranges\|index_ranges_quantity\|transcount:order.item_count` → 5 items
`length`	Returns the length attribute of an array or string.		`piece_ids\|length` → 3
`link`	Formats the result as a link.