Extensible Item Attribute

Extensible Line Item Attributes enable you to capture custom data at the individual line item level on orders, subscriptions, and shipments. For example, you might want to track a gift message specific to a particular product in an order, so you define an order line item attribute that lets the shopper enter a message against that item at checkout. For another example, you might want a CSR to flag a specific line item for special handling after the order is submitted — you create a line item attribute that lets the CSR enter a value post order submit. Shipment line item attributes enable you to capture custom data at the individual line item level within a shipment. For example, a shipment containing a Vase and a Book as two separate line items can have different attribute values per product — the Vase might have “Orientation Required = UPSIDE” while the Book has “Stackable = Yes.” Fulfillment users view and populate shipment line item attribute values during the fulfillment workflow. Note: An attribute can only be configured at either the entity level or the line item level — not both. Entity-level attributes are configured under Extensible Attributes (System > Schema > Extensible Attributes).

​

Order Line Item Attributes

Order line item attributes apply independently to each specific line item within the order. For example, a gift message or a handling flag that applies to a specific line item within the order.

​

Subscription Line Item Attributes

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

​

Shipment Line Item Attributes

Fulfillment users view and populate shipment line item attribute values during the fulfillment workflow. Shipment line item attributes apply independently to each line item within a shipment. For example, Orientation Required, Actual Weight, Pick Zone, or Damage Observed. When both Order and Shipment are selected under Apply Attribute To, the attribute is created for both the order line item and the shipment line item. The Attribute Value Sync Setting determines how the value flows between the order line item and the shipment line item. See the Attribute Value Sync Setting section below for details.

​

Attributes Grid

All line item-level attributes are managed at System > Schema > Extensible Item 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 a Line Item Attribute

1. Go to System > Schema > Extensible Item Attributes.
2. Click Create New 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 a line item 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 order line items before they can be submitted. For shipments, if enabled, the attribute requires a value and the shipment cannot be fulfilled until a value is provided.
      • 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 capture internal handling instructions or operational flags against a line item, but you do not want this information displayed to shoppers.
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 section appears for each selected entity. The Editable setting is available across all entity types and controls whether a line item attribute value can be modified after it has been initially set. For order line item attributes, the Editable setting allows admin to edit the attribute value post order submit. Similarly, for shipment line item attributes, the Editable setting allows fulfiller user to edit the shipment line item 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 determines how the value flows from the order line item to the shipment line item. See the Attribute Value Sync Setting section below for details.

​

Attribute Value Sync Setting

When a line item attribute applies to both Order and Shipment, the Attribute Value Sync Setting determines how the attribute value flows from the order line item to the shipment line item. 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 line item stays in sync with the order line item. Any updates to the order line item value will automatically reflect on the shipment line item. When this option is selected, the Editable setting on the Shipment section is automatically disabled, as the shipment line item value is always driven by the order line item.

​

Do Not Sync Attribute Value

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

​

Disable line item attribute

Line item 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.