Order Attributes

Order attributes enable you to uniquely describe an aspect of an order. Depending on the attribute definition, either you or a shopper can enter values for the attribute. For example, you might want to collect customer feedback on the checkout process, so you define an attribute that lets the shopper rate the checkout experience by selecting a value between 1 and 10. For another example, you might want to track the season associated with an order. To accomplish this, you create an attribute that lets the CSR fulfilling the order enter a season value after the shopper submits the order.

The attribute definition determines whether the attribute displays on the storefront, in Admin, or both on the storefront and in Admin. All attributes you define are available for entry on all orders; however, you can determine whether the attribute is required for each order.

Create Order Attributes

View existing order attributes on the Order Attributes page located at System > Schema > Order Attributes. Use the More Actions button to edit or delete an order attribute.

To create a new order attribute:

  1. Go to System > Schema > Order Attributes.
  2. Click Create New Order Attributes.
  3. In the General section, the complete the following:
    1. Enter an Administration Name.
    2. Enter a Code.
    3. Use the Display Group drop-down menu to specify one of the following options:
      • Admin Only — The attribute only displays in Admin.
        If you select this option, you can only select Admin Entered for the Value Source.
      • Admin & Storefront — The attribute displays both in Admin and on the storefront. Note:  To customize how the attribute displays on your storefront, refer your theme developer to the Global Variables Available in Hypr Templates documentation.
    4. (If applicable)  If you selected Admin & Storefront for the Display Group, provide a Storefront Label.
      This is the label that shoppers will see for the attribute on the storefront.
    5. Use the Value Source drop-down menu to specify one of the following options:
      • Shopper Entered — The shopper can provide a value for the attribute. Note:  Admin users can still edit or enter values for shopper entered attributes.
      • Admin or Shopper Entered — Either the Admin user or shopper can provide a value for the attribute.
      • Admin Entered — The Admin user is the only one who can provide a value for the attribute.
    6. Select a value for each of the following attribute Options:
      • Required — If enabled, the attribute requires a value on all orders, and orders cannot be submitted until a value is provided. The default is disabled (not required).
      • Editable — If enabled, the attribute value cannot be edited once a user provides a value. The default is enabled (editable).
      • Hidden on storefront — If enabled, the attribute is hidden on the storefront. The attribute can still have a value populated, but it is not displayed to shoppers. The default is disabled (show on storefront).
        For example, you might want to collect geo location, cookie information, speciall processing needs, and/or negotiated pricing, but you don't want this information displayed to shoppers.
  4. In the Input section, complete the following:
    1. Use the Input Type drop-down menu to specify the input type for the attribute. You can choose a list, text box, text area, yes/no, or date for the type.
      Depending on the input type and data type you select, other fields might display that require additional information. Note:  If you select a Yes/No type for the attribute, the value defaults to No if a user does not explicitly set the value.
  5. Click Save.

Disable Order Attributes

Kibo eCommerce prevents you from deleting order attributes; however, if you no longer wish for an order attribute to be used, you can disable the order attribute.

Disabling an order attribute prevents you from adding the attribute to an offline order, and the attribute no longer shows on the storfront. When you disable an order attribute that's already in use, Kibo eCommerce prompts you to confirm disabling the in use attribute.

Note:  When you disable a previously used order attribute, the attribute value is still displayed on past orders, but you cannot edit or select the attribute value.

To disable an order attribute:

  1. Go to System > Schema > Order Attributes.
  2. Click the More Actions button next to the applicable attribute and select Disable.
    If prompted, confirm to disable the attribute.