Insites Docs Instance EcommerceEcommerce Custom Fields

Ecommerce Custom Fields

Last updated on August 01, 2024.

Custom fields allow you to craft unique data models for products, categories, and orders. This functionality facilitates data storage beyond the system's default settings, allowing you to create tailored features for your application.

This document discusses the following topics:

  • Creating a custom field
  • Viewing a custom field
  • Updating a custom field
  • Using custom fields
  • Deleting custom fields

Creating a custom field

To create a custom field:

  1. Navigate to Ecommerce from the main menu.
  2. Select Custom Fields.
  3. Navigate to one of the following tabs:

    • Products
    • Categories
    • Orders
  4. Select EDIT CUSTOM FIELDS. When a tab's list of custom fields is empty, an ADD CUSTOM FIELDS button is displayed.
  5. Select ADD CUSTOM FIELDS.
  6. Fill out the form. Input descriptions and requirements are displayed in a table after this step-by-step guide.
  7. Click SAVE FIELD.
  8. Select SAVE.

The input requirements and descriptions for creating a custom field are displayed in the table below:

Input LabelTypeRequiredDescription
Field Name Input Field Yes Name of the custom field.
Field Type Dropdown Field Yes

Type of data stored in the custom field. Options include the following:

  • Array
  • Boolean
  • Date
  • DateTime
  • Data Source
  • Data Source (Multiple)
  • Geo JSON
  • Float
  • Integer
  • Media
  • Time
UI Element Dropdown Field Yes

Type of custom field used in the Instance Admin user interface. Options include the following:

  • Card Select
  • Code
  • Color
  • HTML
  • Link
  • Markdown
  • Multi-Line
  • Phone
  • Radio
  • Select

Viewing a custom field

To view a custom field:

  1. Navigate to Ecommerce from the main menu.
  2. Select Custom Fields.
  3. Navigate to one of the following tabs:

    • Products
    • Categories
    • Orders

Updating a custom field

To update a custom field:

  1. Navigate to Ecommerce from the main menu.
  2. Select Custom Fields.
  3. Navigate to one of the following tabs:

    • Products
    • Categories
    • Orders
  4. Select EDIT CUSTOM FIELDS.
  5. Select the custom field you want to update.
  6. Make your changes.
  7. Click SAVE FIELD.
  8. Select SAVE.

Using custom fields

Once a custom field is added to a product, category, or order, it can be used in the Instance Admin to store custom data. To use the custom fields:

  1. Navigate to Ecommerce from the main menu.
  2. Initiate adding or updating a product, category, or order.
  3. Fill out or update the custom fields.
  4. Save your data.

Deleting custom fields

To delete custom fields:

  1. Navigate to Ecommerce from the main menu.
  2. Select Custom Fields.
  3. Navigate to one of the following tabs:

    • Products
    • Categories
    • Orders
  4. Select EDIT CUSTOM FIELDS.
  5. Select the custom field you want to delete.
  6. Select DELETE FIELD.
  7. Select SAVE.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.