Attributes and attribute groups are created and managed in the Order Management Attribute Manager. Attribute values for specific objects are set on the pages used to edit those objects. You can specify whether you want attributes to be visible, searchable, editable, or clonable. Note that if the Clonable option is selected, then that attributes can be copied when executing an even swap, reshipment, or adjustment in Customer Service Center.
To create a custom attribute, follow these steps:
To edit a custom attribute, first search for it in one of the following ways:
The following table describes the fields used to define an attribute:
Field | Type | Description | Required/ Optional |
---|---|---|---|
Group | Dropdown list | The attribute group to which the attribute is assigned | Optional (the empty list item is selected if not assigned to a group) |
Id | Text | An identifier used to reference the attribute in code | Optional (required for use in templates or web service/ API calls) |
Label | Text | An identifier used to reference the attribute in the various user interface pages. | Required |
Short Label | Text | An abbreviated identifier used to reference the attribute in the various Order Management pages. | Optional |
Description | Text | A detailed description of the attribute | Optional |
Tag | Text | A text field that can be referenced in code as desired | Optional |
Multiple Values | Checkbox | If checked, then the attribute can store multiple values. If not checked, then the attribute can only hold a single value. (Default: unchecked) | Optional |
Range Values | Checkbox | If checked, then the attribute can store a range of values. If not checked, then the attribute can only hold a single value. (Default: unchecked) | Optional |
Other | Checkbox | Only affects choice value attributes. If checked, then the attribute can hold a value other than the ones defined in its list of choice values. (Default: unchecked) | Optional |
Visible | Checkbox | If checked, then the attribute is visible in the Order Management page when viewing an object of an associated type. If unchecked, then it's hidden from the page. (Default: checked) | Optional |
Searchable | Checkbox | If checked, then the attribute is searchable. If unchecked, then it isn't searchable. (Default: unchecked) | Optional |
Clonable | Checkbox | If checked, then the attribute can be cloned when executing even swaps, reships, and adjustments in Customer Service Center. If unchecked, then the attribute is not cloned. (Default: unchecked) | Optional |
Publicly Visible | Checkbox | If checked, then the attribute can be made visible to Customers when viewing an object of an associated type. If unchecked, then it's hidden from customers. (Default: unchecked) | Optional |
Publicly Searchable | Checkbox | If checked, then customers can search on the attribute. If unchecked, then customers cannot search on it. (Default: unchecked) | Optional |
Publicly Editable | Checkbox | If checked, then customers can edit the attribute when viewing an object of an
associated type. This feature includes editing of order-level and item-level custom attributes in Customer Service. If unchecked, then customers cannot edit it. (Default: unchecked) |
Optional |
Configuration Type | List | The base datatype of the attribute value. Options
include:
|
Required |
Configuration Subtype | List | The display format of the attribute's value. Only applies
to attributes of type String or Choice Value.
|
Required |
Attach Object | List and button | Attach the attribute to an object type by selecting the type from the list and clicking Attach to Object. The attached object type appears below the list. You can attach the attribute to multiple object types. The attribute is available to be set on all objects of types to which it is attached. | Optional (Attribute must be assigned to at least one object type to be
used.) Note: When creating allocation rules, create a fulfillment site attribute
and then associate that attribute to the Fulfillment Site Object type. Then
associate the value you want to set for the fulfillment site attribute, such as
string, number, or choice value.
|
When creating a choice value attribute, you must define the values that can be chosen. Define them via the Choice Values form. After selecting Choice Value as the configuration type, click Update. The Choice Values form appears on the page.
There are two ways to create the values: they can be typed individually, or can be imported as a set of character-delimited values. The methods can be combined. Each method is described following.
Typing values
To enter the values by typing them one at a time, follow these steps:
Importing values
To import a set of values, either copy them from a character-delimited file or type them as a set of character-delimited fields, one value per line. Valid delimiters include tab, pipe (|), and comma (,). Follow these steps:
You can change the display order of values in the list using the red arrows on the right side of each value's row. Doing so automatically assignsorder numbers to all values in the list.
To delete a value, click the trash can icon on the right side of its row. To delete all values, click Delete All on the right side of the form. Deletions can't be undone.
To create a custom attribute group, do the following: