Hi. How can we help?

Using order extra fields in eCom (E-Series)

Working with eCom (E-Series) API platform requires advanced programming skills. If you need developer assistance, check out the eCom (E-Series) custom development team.

Order extra fields allow you to save additional information to orders. Buyers can add custom data at checkout and this information will appear in the order details in your eCom (E-Series) Admin Panel. These fields can be visible or hidden from customers.

Additional tools for working with order extra fields include two functions and an array of objects: getOrderExtraFieldValue("key"), getOrderExtraField("key"), order.extraFields.

Order extra fields structure

${order.extraFields}

  • <#list order.extrafields="order.extraFields" as="as" extrafield="extraField"> </#list>: Displays the list of order extra fields.
  • ${extraField.key}: Displays the extra field key.
  • ${extraField.value}: Displays the extra field value.
  • ${extraField.title}: Displays the extra field title.
  • ${extraField.orderDisplaySection}: Defines what order section the extra field values are shown in.
  • ${extraField.type}: Displays the extra field type.

Order extra fields examples

Show all order extra fields set to be visible in order details (title and orderDisplaySection are specified):

<#list order.extraFields as extraField>
<#if extraField.title?has_content && extraField.orderDisplaySection?has_content>
${extraField.title}: ${extraField.value}
</#if>
</#list>

Print value of a specific order extra field (where askHowYouFoundUsApp is the key of your order extra field):

<#assign myExtraFieldValue = getOrderExtraFieldValue("askHowYouFoundUsApp")>
<#if myExtraFieldValue?has_content>
${myExtraFieldValue}
</#if>

Print specific fields of a specific order extra field (where you remove fields you don't want to show and askHowYouFoundUsApp is the key of your order extra field):

<#assign myExtraField = getOrderExtraField("askHowYouFoundUsApp")>
${myExtraField.key}
${myExtraField.value}
${myExtraField.type}
${myExtraField.orderDisplaySection}
${myExtraField.title}

What's next?

Adding features using the eCom (E-Series) API

Requires advanced programming skills.

Learn more

Custom development services for eCom (E-Series)

Request custom enhancements to your online store.

Learn more

Was this article helpful?