ChannelEngine: product custom fields/extra data fields

About this document

This document describes product custom fields on ChannelEngine, how to create them, and how to manage them.

Introduction

There are two types of product attributes on ChannelEngine:

  • Default attributes - such as Name, Description, Price, Image URL, etc. If used in replacement tags, these have a {CE:[ATTRIBUTE_NAME]} label.
  • Custom attributes - which can be anything like Number of wheels, Warranty period, Weight, etc. If used in replacement tags, these have a {MY:[ATTRIBUTE_NAME]} label.

Custom attributes, also known as custom fields or extra data fields, can be added via a product feed, ChannelEngine's API, or the ChannelEngine interface. For certain plugins and custom integrations the option to add new custom fields can vary). Once these extra attributes are added to ChannelEngine, they can be managed via Products > Custom fields.

Adding custom fields to ChannelEngine

  • ChannelEngine's API - custom fields can be created via the POST /v2/products endpoint.
  • 		"ExtraData": [
          {
            "Key": "string",
            "Value": "string",
            "Type": "TEXT",
            "IsPublic": true
          }
        ]
    	
  • Product feed - custom fields can be added as extra columns. If you have several feeds, the unique product identifier required in each feed is the Merchant product number.
  • ChannelEngine's interface - go to Products > Custom fields and select + Add custom field.

Managing custom fields on ChannelEngine

ChannelEngine back-end: custom fields overview

In the Custom fields overview, your custom fields can be visualized in a list. There are four columns:

  1. Name - the name of the custom field. It is possible to change this, but note that any changes made in this section are reflected in many other parts of the system, including advanced mapping rules.
  2. Type - the attribute's data type. There are currently four types: Text, Number, URL, and Image URL. These data types are currently not in use, as all custom fields are considered strings of data, but may become relevant in future.
  3. Is public? - defines if an attribute is considered public or not. If its value is true (i.e.: yes), this attribute is included in feeds for custom channels or click-and-ad channels. If its value is false (i.e.: no), the attribute can still be used for channel mappings but is not included in exports for custom product feeds and custom channels.
  4. Actions - there are three types of actions available:
    • Information - shows if and where a custom field is in use, and if it can be deleted.
    • Edit - allows you to change the name, type, and the public status of the attribute. Make sure to select the Save  icon to store any changes made.
    • Delete - allows you to delete custom fields. If a custom field is in use in mappings or rules, it cannot be deleted.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.