Order attributes let you create a range of custom attributes you can apply to Orders, Invoices, Locations, Networks, and more. For example, you could create a custom attribute that would allow customers to select gift wrapping at checkout.

Prerequisites

  • Ensure that you have Administrator or Editor privileges to fabric Orders. For more detailed information on these settings, see the Role-Based Access Control section

Procedure

  1. In the left menu, click Orders > Settings > Attributes.

    The Attributes page is displayed.

  2. Click Create Attribute.

    The Create Attribute page is displayed.

  3. In the Attribute name field, enter an attribute name.

  4. To make the attribute mandatory, select the Mandatory attribute field.

  5. (Optional) In the Description field, enter a description.

  6. In the Data type field, select a data type. For example, Integer or Boolean.

  7. In the Document field, select a document type.

    This field is used to map the attribute to the fabric API endpoint. For example, if you select inventory and the attribute is a mandatory attribute, you are required to provide this attribute and its value when making an API call to inventory.

  8. In the Object field, select an object.

    The object field is used to further classify where an attribute lives. For example, if you select the Order document type and ShipInfo object. The attribute lives under the order.shipInfo object as the order.shipInfo.shopToType attribute.

  9. Click Save.

The attribute is added to the attribute table on the Attributes page.

Was this page helpful?