Order Attributes

Order Attributes are used for collecting information from customers during the Checkout process. Begin setting up Order Attributes by navigating to Orders > Attributes

Order Attributes List

The Orders > Attributes page will list all Order Attributes created by the Admin. The Admin may search, sort, delete or select to edit the Attributes. New Attributes may be created by clicking "Create New Attribute".

Main Settings

When creating or editing an Order Attribute, the following settings will be available.

Attribute Name

The name or label that will show on the form field to give the attribute a value on your order.

Attribute Type

Attribute Type determines the field type used for entry by the customer during Checkout.

Enabled

This setting determines whether or not the Order Attribute is enabled. If disabled, the form field will not show in the checkout where specified.

Order Visibility Settings

Visible to only specified customer groups

This setting allows the Order Attribute Form Field to only be shown to specific customer groups. After checking the setting a list of groups will appear. Select the groups that will be able to see this attribute.

Editable In Admin

This setting determines whether or not the Order Attribute Value can be edited on the order by the store administrator.

Show on PDFs

This setting determines whether or not the Order Attribute Value is shown in PDF Documents in the "Display Location " selected above.

Show on Emails

This setting determines whether or not the Order Attribute Value is shown in Order Emails in the "Display Location " selected above.

Show on Customer My Account: View Order

This setting determines whether or not the Order Attribute Value is shown to the customer in their My Account View Order page

Show on Order Success Page

This setting determines whether or not the Order Attribute Value is shown in the Order Success Page in the "Display Location " selected above.

Show on Export Full Order Data CSV

This setting determines whether or not the Order Attribute is added as a column in the Order CSV Export.

Order Forms Settings

Required

This setting determines whether or not the Order Attribute is required in the checkout where specified.

Checkout Location & Checkout Position

This setting allows the Order Attribute Form Field on the Billing Address, Shipping Address, Shipping Method or Payment Method pages of the Checkout. The Checkout Position setting allows for showing the Order Attribute Form Field Above or Below other default fields on those pages in the checkout.

Display Location

This determines where the information is displayed after the order is placed within the Admin, My Account, Email, and PDF.

Sort Order In Forms

This setting is used when multiple Order Attributes are added to the same Checkout and Display Location to determine the sort order.

Order Attribute API

Below are sample API requests for wsi and wsdl mode

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:salesOrderUpdateAttributesRequestParam>
         <sessionId></sessionId>
         <orderIncrementId></orderIncrementId>
         <orderAttributes>
            <complexObjectArray>
                <attribute_code>attribute_code_one</attribute_code>
                <attribute_value>New Value One</attribute_value>
            </complexObjectArray>
            <complexObjectArray>
                <attribute_code>attribute_code_two</attribute_code>
                <attribute_value>New Value Two</attribute_value>
            </complexObjectArray>
         </orderAttributes>
      </urn:salesOrderUpdateAttributesRequestParam>
   </soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:salesOrderUpdateAttributes soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <sessionId xsi:type="xsd:string"></sessionId>
         <orderIncrementId xsi:type="xsd:string"></orderIncrementId>
         <orderAttributes xsi:type="urn:salesOrderUpdateAttributesEntityArray" soapenc:arrayType="urn:salesOrderUpdateAttributesEntity[]">
            <salesOrderUpdateAttributesEntity>
                <attribute_code>attribute_code_one</attribute_code>
                <attribute_value>New Value One</attribute_value>
            </salesOrderUpdateAttributesEntity>
            <salesOrderUpdateAttributesEntity>
                <attribute_code>attribute_code_two</attribute_code>
                <attribute_value>New Value Two</attribute_value>
            </salesOrderUpdateAttributesEntity>
         </orderAttributes>
      </urn:salesOrderUpdateAttributes>
   </soapenv:Body>
</soapenv:Envelope>