Order Attributes

Rachael Norris
Rachael Norris
  • Updated

You can set up Order Attributes to store extra information about Orders on your Spektrix system.

In this article, we’ll provide some example use cases and cover how to create an Order Attribute.

Before getting started with Order Attributes, take a look at:


Why use Order Attributes?

You can use Order Attributes to store extra information alongside Orders.

Order Attributes will display as additional fields to be completed by the Sales User or Customer when placing an Order. Sales Users can retrospectively apply Order Attributes by editing an Order

If needed, you can make the Attribute required to ensure this information is always completed. 

REMINDER: If you make an Order Attribute required, it will be required on every Order going forward. However, you can make Order Attributes required on only certain Events.


Example use cases

You can use Order Attributes to collect extra information from customers at the point of purchase. Here are two examples of how they can be used in practice.

  • You could use an Order Attribute to collect Student ID numbers for a graduation Event that is only open to students. To do this you would create an Order Attribute called ‘Student ID’. 

    You could then limit the number of characters to the number of characters in each ID, make the Attribute required and unique. The customer to have to enter a unique ID number to be able complete the Order. 

    TIP: If you want to display this Attribute online, you’ll need to make this Attribute available in the API or in iframe integrations.

  • If you’re hosting an Event such as a Gala where the attendees will receive a dining package, you can use an Order Attribute to capture information about the Attendee’s dietary requirements. 

    To do this you could create an Order Attribute called ‘Dietary Requirements’ using a Dropdown List to display the options. For example, Gluten Free, Dairy Free, Vegetarian, Vegan, etc.

    TIP: You can also add a free text option to a Dropdown List to let users enter options which you have not provided.

    You might also want to make the Order Attribute required on only the Gala Event. You can learn how to make Order Attributes required for certain Events in the Adding an Order Attribute to an Event section of this article.


How to create an Order Attribute

To create a new Order Attribute, navigate to the Settings Interface > Attributes > Order.

TIP: You'll need the Settings Administrator user role to create and edit Attributes. If you don’t have this permission, ask the administrator in your organisation.

Click the New Attribute Definition button:


Attribute Definition

Next, you’ll be asked to input information to define the parameters of your Attribute.

WARNING: You cannot change the name of an Attribute once you have created it.


Complete the following information.

  • Name: give the Attribute a clear and descriptive name. Attribute names cannot include special characters (, . - & ! / etc.). Your Attribute name cannot be longer than 50 characters.

TIP: Consider if your Attribute will be visible to customers on your website when choosing the name of your Attribute.

  • Type: choose the Attribute Type.

  • Description: use this field to make it clear to other members of your team what the purpose of this Attribute is. This description will only be visible in the Sales Interface.

  • This Attribute is visible in your API integrations: check this box to make this Attribute available to the API.
  • This Attribute is visible in your iframe integrations: check this box to make this Attribute available in iframes.
  • This Attribute is always required: check this box to make it so that this Attribute cannot be skipped or left empty.

    Required Attributes will appear with a red line. You’ll need to enter information in order to proceed:

REMINDER: Check Box Attributes can never be set to required, as they work on a Yes/No response. This means that leaving the box unchecked is a valid response.

REMINDER: If you make an Order Attribute required, it will be required on every Order going forward. However, you can make Order Attributes required on only certain Events.

  • This Attribute is protected: this option is greyed out as you cannot protect Order Attributes.

TIP: You can use protected Customer Attributes to collect and store sensitive information.

  • Length: choose the maximum number of characters that can be entered, or set the exact number of characters which have to be entered to proceed. A text field can contain a maximum of 255 characters.

  • Allow users to enter free text for this Attribute: this option is only available for Dropdown List Attributes.

  • Unique Value: check this box if you require a unique Value to be entered every time.

Once you are happy with the information inputted, click Create Attribute Definition.


Attribute Values

If you choose a Dropdown List, you will then need to add in the Values. 

Type each of your Values for this Attribute on a separate line. Each line appears as a Value in this Attribute’s Dropdown List:

  • Click here to see how to edit dropdown Values

    • Select the Attribute you want to edit. 
    • Go to Attribute Values.
    • To add a new Attribute Value click New Attribute Value.
    • You can rearrange the Values by clicking and dragging them from the grey dots on the left:

    • Clicking the grey trash can icon will delete the Attribute Value.
    • Click on the name of the Attribute Value to edit.

    WARNING: Editing the name of an Attribute Value will replace all existing Values with the new Value. If your website integration uses this Attribute then this may prevent your website from working properly.

    • Click Update Attribute Value if you are happy to proceed.


Order Attributes in the Sales Interface

All Order Attributes will appear in the Sales Interface in two different ways. 

This depends on whether you have the Pre Payment Options panel in the Basket/Cart switched on. 

  • Click to expand the Pre Payment Options above the Payments section:


Your Order Attributes will appear beneath any Donation asks and the Customer Questionnaire:

TIP: Set Order Attributes will appear outlined in red if there is a required Order Attribute that needs to be completed before the Order can be confirmed.

This will open a new window where you can add the Order Attribute Values:


Adding an Order Attribute to an Event

You can add Order Attributes to certain Events in the Admin Interface. 

Go to the Admin Interface > Events, find the Event you want to attach the Order Attribute to.

Select Order Attributes from the Event Details menu on the left:


  • You will see all of the available Order Attributes listed. Select Edit
  • To make an Attribute appear online to Customers, check the On Web box. 
  • If you want the Attribute to be a mandatory field, check the Required box. This means the Order cannot be completed online or in the box office without entering the Attribute information. 
  • Click Save.


Order Attributes online

If you use a Custom API Basket/Cart Order Attributes will appear in the purchase path automatically.

Order Attributes are visible to Customers in iframe integrations in both Classic and Express Checkout.

Here’s an example of how that might look in Express Checkout:

And Classic Checkout:


Further Reading

To continue learning about Orders, take a look at the following articles:

You can find more articles on Managing Orders in the Sell items and Fulfill Orders section of the Support Centre.