Meta Data
      Back to home
      1. Help Center
      2. Developers
      3. Meta Data

      Creating Custom Attributes/Meta Data for a Allocations

      Custom Allocation Meta Data allows you to save additional information on each Allocation. This is typically used by developers to group or add additional information on the website.

      1. To create an attribute for a Allocation, navigate to Developer > Meta Data
      2. Click the Allocation tab from the options at the top of the screen and then click Add Allocation Meta Data
        Screen Shot 2023-02-08 at 5.06.22 PM
      3. Select a Title for your attribute. For an example: "Notes for Allocation".
        Screen Shot 2023-02-08 at 7.10.46 PM
      4. Code is just a reference point for doing API calls. You do not need to change this, but you can if you'd like. 
      5. Next select your Data Type. There are 11 different data types available. For this example, we are using a Text Box. Learn more about the Data Types here.
      6. Decide whether or not you want your attribute to be a Required field. If it's required, it will need to be entered in order for the Allocation to be saved.
      7. Finally you can set the Sort Order. The sort order determines the order your attribute will appear in the Allocations Meta Data tab. 
      8. Click Add Allocation Meta Data when you're finished building your attribute.
      9. Now You can go over to an Allocation and test it out. Click on Store > Allocations > choose the allocation > Click the Meta Data tab. You will now see the Notes text box.

       


      Before You Save, Choose Your Option Titles Wisely!

      If you have chosen a 'text' Data Type such as 'Radio', 'Checkbox', or 'Select', make sure to carefully select your option title. Once saved, if you later edit the title, you will only be able to filter using the new title.

      Screen Shot 2024-03-27 at 3.09.41 PM

      Example:

      1. You have Order Meta Data for "Source" and your options are: Social, Friends & Family, and Google. 
      2. You select the value of "Social" on Order #1012. 
      3. You change your Order Meta Title to rename "Social" to "Social Media".
      4. Order #1012 that has "Social" selected will not have "Social Media" selected. (This is because the backend doesn't know that "Social" and "Social Media" are the same thing. Since the text doesn't match, it thinks that it's a different value).
      5. If you filter by the Order Meta Data of "Social Media", the Order with "Social" selected will not be included in the results. (Note that unfiltered Order Exports will contain both). 

       

      FAQ


      Can I re-order the Options after the fact? Yes! As long as the text matches, there are no issues with changing the display order.