Extensible Attribute

Extensible Attributes enable you to uniquely describe an aspect of an order, subscription, or shipment with values selected by either an Admin user or the shopper. For example, you might want to collect customer feedback on the checkout process, so you define an order 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 order attribute that lets the CSR fulfilling the order enter a value after the shopper submits the order. Shipment attributes enable you to capture custom, business-specific data at the shipment level. For example, a shipment attribute can be used to track Handle with Care or Special Carrier Instructions that apply to the entire shipment. Fulfillment users view and populate shipment attribute values during the fulfillment workflow. Note: Attributes previously configured under Order Attributes (System > Schema > Order Attributes) and Shipment Attributes (System > Schema > Shipment Attributes) are now available under System > Schema > Extensible Attributes.

​

Order Attributes

Order attributes apply a single value to the entire order. For example, you might want to track the season associated with an order, or capture a special instruction that applies to the whole order.

​

Subscription Attributes

Similar to order attributes, subscription attributes can also be created by selecting Subscription under Apply Attribute To.

​

Shipment Attributes

Fulfillment users view and populate shipment attribute values during the fulfillment workflow. Shipment attributes apply a single value to the entire shipment. For example, Handle with Care, Special Carrier Instructions, or Delivery Notes. When both Order and Shipment are selected under Apply Attribute To, the attribute is created for both the order and the shipment. The Attribute Value Sync Setting determines how the value flows between the order and the shipment. See the Attribute Value Sync Setting section below for details.

​

Attributes Grid

All entity-level attributes are managed at System > Schema > Extensible Attributes. You can filter the data grid by entity type — Order, Subscription, or Shipment — and toggle columns on or off using the dropdown on the far right of the data grid headers. To edit an existing attribute or disable one that is currently enabled, click the attribute in the data grid to open its settings.

​

Create an Attribute

1. Go to System > Schema > Extensible Attribute
2. Click Create New Extensible Attribute
3. In the General section, 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.
   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.
      • 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. In the Apply Attribute To setting, select one or more entities this attribute applies to — Order, Subscription, or Shipment. You can create an attribute for a single entity or select multiple entities. This selection cannot be changed after the attribute is saved.
   7. Select a value under Options.
      • Required: If enabled, the attribute requires a value on all orders before they can be submitted. For shipments, the attribute requires a value before the shipment can be fulfilled.
      • Hidden from shopper: If enabled, the attribute is hidden on the storefront. The attribute can still have a value populated, but it is not displayed to shoppers.
        For example, you might want to collect geo location, cookie information, special processing needs, and/or negotiated pricing, but you don’t want this information displayed to shoppers.
      • Available for Discounts: If enabled, the attribute will be available for use in discount conditions.
      • Available as Order Routing Filter: If enabled, the attribute can be used as a filter condition within Order Routing.
4. In the Input section, 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 may display that require additional information
5. Review the Entity Configuration section, which appears based on your Apply Attribute To selection. See the Entity Configuration section below for details.
6. Click Save.

​

Entity Configuration

After selecting one or more entities under Apply Attribute To, a configuration block appears for each selected entity. The Editable setting is available across all entity types and controls whether an attribute value can be modified after it has been initially set. For order attributes, the Editable setting allows admin to edit the attribute value post order submit. Similarly, for shipment attributes, the Editable setting allows fulfiller user to edit the shipment attribute after the shipment has been created. When both Order and Shipment are selected under Apply Attribute To, an additional setting — Attribute Value Sync Setting — appears within the Shipment section. The Attribute Value Sync Setting determines how the value flows from the order to the shipment. See the Attribute Value Sync Setting section below for details.

​

Attribute Value Sync Setting

When an attribute applies to both Order and Shipment, the Attribute Value Sync Setting determines how the attribute value flows from the order to the shipment. This setting is configured inside the Shipment section and cannot be changed after the attribute is saved.

​

Sync Attribute Value

The attribute value on the shipment stays in sync with the order. Any updates to the order value will automatically reflect on the shipment. When this option is selected, the Editable setting on the Shipment section is automatically disabled, as the shipment value is always driven by the order.

​

Do Not Sync Attribute Value

The shipment takes the order’s value on shipment creation. After that, updates to the order value will not reflect on the shipment.

​

Disable Attribute

Attributes can be disabled by selecting Disable from the actions menu next to the applicable attribute. Disabling a line item attribute prevents it from being added to new orders, subscriptions, or shipments.